assertThrows | /test_deps.ts | test_suite@0.16.1 | Deno

Skip to main content

x/test_suite/test_deps.ts>assertThrows

An extension of Deno's built-in test runner to add setup/teardown hooks and make it easier to organize tests in a format similar to Jasmine, Jest, and Mocha.

udibo/test_suite

Latest

Menu

function assertThrows

import { assertThrows } from "https://deno.land/x/test_suite@0.16.1/test_deps.ts";

assertThrows<E extends Error = Error>(

fn: () => unknown,

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

msgIncludes?: string,

msg?: string,

): void

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. Or you can pass a callback which will be passed the error, usually to apply some custom assertions on it.

assertThrows(

fn: () => unknown,

errorCallback: (e: Error) => unknown,

msg?: string,

): void

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. Or you can pass a callback which will be passed the error, usually to apply some custom assertions on it.

Type Parameters

optional

E extends Error = Error

Parameters

fn: () => unknown

optional

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

optional

msgIncludes: string

optional

msg: string

Returns

void

Parameters

fn: () => unknown

errorCallback: (e: Error) => unknown

optional

msg: string

Returns

void