asserts.assertRejects | /deps.ts | dtils@1.3.1

function asserts.assertRejects

import { asserts } from "https://deno.land/x/dtils@1.3.1/deps.ts";
const { assertRejects } = asserts;

assertRejects(fn: () => PromiseLike<unknown>, msg?: string): Promise<unknown>

Executes a function which returns a promise, expecting it to reject.

assertRejects<E extends Error = Error>(

fn: () => PromiseLike<unknown>,

ErrorClass: new (...args: any[]) => E,

msgIncludes?: string,

msg?: string,

): Promise<E>

Executes a function which returns a promise, expecting it to reject. If it does not, then it throws. An error class and a string that should be included in the error message can also be asserted.

Deprecated

Use assertRejects(fn, msg) instead, which now returns rejected value and you can assert on it.

assertRejects(

fn: () => PromiseLike<unknown>,

errorCallback: (e: Error) => unknown,

msg?: string,

): Promise<Error>

Executes a function which returns a promise, expecting it to reject.

Parameters

fn: () => PromiseLike<unknown>

optional

msg: string

Returns

Promise<unknown>

Executes a function which returns a promise, expecting it to reject. If it does not, then it throws. An error class and a string that should be included in the error message can also be asserted.

Type Parameters

optional

E extends Error = Error

Parameters

fn: () => PromiseLike<unknown>

ErrorClass: new (...args: any[]) => E

optional

msgIncludes: string

optional

msg: string

Returns

Promise<E>

Parameters

fn: () => PromiseLike<unknown>

errorCallback: (e: Error) => unknown

optional

msg: string

Returns

Promise<Error>