assertThrows | /packages/flags/test/lib/assert.ts | cliffy@v0.4.0

function assertThrows

import { assertThrows } from "https://deno.land/x/cliffy@v0.4.0/packages/flags/test/lib/assert.ts";

assertThrows(fn: () => unknown, msg?: string): unknown

Executes a function, expecting it to throw. If it does not, then it throws.

assertThrows<E extends Error = Error>(

fn: () => unknown,

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

msgIncludes?: string,

msg?: string,

): E

Executes a function, expecting it to throw. 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 assertThrows(fn, msg) instead, which now returns thrown value and you can assert on it.

assertThrows(

fn: () => unknown,

errorCallback: (e: Error) => unknown,

msg?: string,

): Error

Executes a function, expecting it to throw. If it does not, then it throws.

Parameters

fn: () => unknown

optional

msg: string

Returns

unknown

Executes a function, expecting it to throw. 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: () => unknown

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

optional

msgIncludes: string

optional

msg: string

Returns

Parameters

fn: () => unknown

errorCallback: (e: Error) => unknown

optional

msg: string

Returns

Error