asserts.assertIsError | /src/service/deps.ts | hex@0.5.15

Deno 2 is finally here 🎉️

An ecosystem delivering practices, philosophy and portability.

function asserts.assertIsError

import { asserts } from "https://deno.land/x/hex@0.5.15/src/service/deps.ts";
const { assertIsError } = asserts;

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