assertIsError | /testing/asserts.ts | std@0.181.0

function assertIsError

import { assertIsError } from "https://dotland.deno.dev/std@0.181.0/testing/asserts.ts";

assertIsError<E extends Error = Error>(

error: unknown,

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

msgIncludes?: string,

msg?: string,

): asserts error is E

Make an assertion that error is an Error. If not then an error will be thrown. 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

error: unknown

optional

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

optional

msgIncludes: string

optional

msg: string

Returns

asserts error is E