mirror of
https://github.com/denoland/std.git
synced 2024-11-21 20:50:22 +00:00
66 lines
2.3 KiB
TypeScript
66 lines
2.3 KiB
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
import { AssertionError } from "./assertion_error.ts";
|
|
import { stripAnsiCode } from "@std/internal/styles";
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @example Usage
|
|
* ```ts no-eval
|
|
* import { assertIsError } from "@std/assert/assert-is-error";
|
|
*
|
|
* 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
|
|
* ```
|
|
*
|
|
* @typeParam E The type of the error to assert.
|
|
* @param error The error to assert.
|
|
* @param ErrorClass The optional error class to assert.
|
|
* @param msgMatches The optional string or RegExp to assert in the error message.
|
|
* @param msg The optional message to display if the assertion fails.
|
|
*/
|
|
export function assertIsError<E extends Error = Error>(
|
|
error: unknown,
|
|
// deno-lint-ignore no-explicit-any
|
|
ErrorClass?: new (...args: any[]) => E,
|
|
msgMatches?: string | RegExp,
|
|
msg?: string,
|
|
): asserts error is E {
|
|
const msgSuffix = msg ? `: ${msg}` : ".";
|
|
if (!(error instanceof Error)) {
|
|
throw new AssertionError(
|
|
`Expected "error" to be an Error object${msgSuffix}}`,
|
|
);
|
|
}
|
|
if (ErrorClass && !(error instanceof ErrorClass)) {
|
|
msg =
|
|
`Expected error to be instance of "${ErrorClass.name}", but was "${error?.constructor?.name}"${msgSuffix}`;
|
|
throw new AssertionError(msg);
|
|
}
|
|
let msgCheck;
|
|
if (typeof msgMatches === "string") {
|
|
msgCheck = stripAnsiCode(error.message).includes(
|
|
stripAnsiCode(msgMatches),
|
|
);
|
|
}
|
|
if (msgMatches instanceof RegExp) {
|
|
msgCheck = msgMatches.test(stripAnsiCode(error.message));
|
|
}
|
|
|
|
if (msgMatches && !msgCheck) {
|
|
msg = `Expected error message to include ${
|
|
msgMatches instanceof RegExp
|
|
? msgMatches.toString()
|
|
: JSON.stringify(msgMatches)
|
|
}, but got ${JSON.stringify(error?.message)}${msgSuffix}`;
|
|
throw new AssertionError(msg);
|
|
}
|
|
}
|