Skip to main content
Home
Browse packagesDocs
Sign In with GitHubSign In with GitLab

@std/testing@0.215.0

latest
Works with
It is unknown whether this package works with Browsers, Deno, Node.js, Cloudflare Workers, Bun
It is unknown whether this package works with Browsers
It is unknown whether this package works with Deno
It is unknown whether this package works with Node.js
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Bun
•JSR Score52%•
Published2 years ago (0.215.0)
function assertIsError
assertIsError<E extends Error = Error>(
error: unknown,
ErrorClass?: new (...args: any[]) => E,
msgMatches?: string | RegExp,
msg?: string
): asserts error is E
Deprecated

(will be removed after 1.0.0) Import from https://deno.land/std/assert/assert_is_error.ts instead.

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.

Examples

Example 1

import { assertIsError } from "@std/testing/asserts";

assertIsError(null); // Throws
assertIsError(new RangeError("Out of range")); // Doesn't throw
assertIsError(new RangeError("Out of range"), SyntaxError); // Throws
assertIsError(new RangeError("Out of range"), SyntaxError, "Out of range"); // Doesn't throw
assertIsError(new RangeError("Out of range"), SyntaxError, "Within range"); // Throws

Type Parameters

E extends Error = Error

Parameters

error: unknown
optional
ErrorClass: new (...args: any[]) => E
optional
msgMatches: string | RegExp
optional
msg: string

Return Type

asserts error is E

Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@std/testing

Import symbol

import { assertIsError } from "@std/testing/asserts";
or

Import directly with a jsr specifier

import { assertIsError } from "jsr:@std/testing/asserts";