mirror of
https://github.com/denoland/std.git
synced 2024-11-21 20:50:22 +00:00
5803cc9172
* BREAKING(assert): remove `assert` from module names * work * fix * work * work * tweaks * fix
113 lines
3.3 KiB
TypeScript
113 lines
3.3 KiB
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
import { assertIsError } from "./is_error.ts";
|
|
import { AssertionError } from "./assertion_error.ts";
|
|
|
|
/**
|
|
* Executes a function, expecting it to throw. If it does not, then it
|
|
* throws.
|
|
*
|
|
* To assert that an asynchronous function rejects, use
|
|
* {@linkcode assertRejects}.
|
|
*
|
|
* @example Usage
|
|
* ```ts no-eval
|
|
* import { assertThrows } from "@std/assert";
|
|
*
|
|
* assertThrows(() => { throw new TypeError("hello world!"); }); // Doesn't throw
|
|
* assertThrows(() => console.log("hello world!")); // Throws
|
|
* ```
|
|
*
|
|
* @param fn The function to execute.
|
|
* @param msg The optional message to display if the assertion fails.
|
|
* @returns The error that was thrown.
|
|
*/
|
|
export function assertThrows(
|
|
fn: () => unknown,
|
|
msg?: string,
|
|
): unknown;
|
|
/**
|
|
* 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.
|
|
*
|
|
* To assert that an asynchronous function rejects, use
|
|
* {@linkcode assertRejects}.
|
|
*
|
|
* @example Usage
|
|
* ```ts no-eval
|
|
* import { assertThrows } from "@std/assert";
|
|
*
|
|
* assertThrows(() => { throw new TypeError("hello world!"); }, TypeError); // Doesn't throw
|
|
* assertThrows(() => { throw new TypeError("hello world!"); }, RangeError); // Throws
|
|
* ```
|
|
*
|
|
* @typeParam E The error class to assert.
|
|
* @param fn The function to execute.
|
|
* @param ErrorClass The error class to assert.
|
|
* @param msgIncludes The string that should be included in the error message.
|
|
* @param msg The optional message to display if the assertion fails.
|
|
* @returns The error that was thrown.
|
|
*/
|
|
export function assertThrows<E extends Error = Error>(
|
|
fn: () => unknown,
|
|
// deno-lint-ignore no-explicit-any
|
|
ErrorClass: new (...args: any[]) => E,
|
|
msgIncludes?: string,
|
|
msg?: string,
|
|
): E;
|
|
export function assertThrows<E extends Error = Error>(
|
|
fn: () => unknown,
|
|
errorClassOrMsg?:
|
|
// deno-lint-ignore no-explicit-any
|
|
| (new (...args: any[]) => E)
|
|
| string,
|
|
msgIncludesOrMsg?: string,
|
|
msg?: string,
|
|
): E | Error | unknown {
|
|
// deno-lint-ignore no-explicit-any
|
|
let ErrorClass: (new (...args: any[]) => E) | undefined = undefined;
|
|
let msgIncludes: string | undefined = undefined;
|
|
let err;
|
|
|
|
if (typeof errorClassOrMsg !== "string") {
|
|
if (
|
|
errorClassOrMsg === undefined ||
|
|
errorClassOrMsg?.prototype instanceof Error ||
|
|
errorClassOrMsg?.prototype === Error.prototype
|
|
) {
|
|
// deno-lint-ignore no-explicit-any
|
|
ErrorClass = errorClassOrMsg as new (...args: any[]) => E;
|
|
msgIncludes = msgIncludesOrMsg;
|
|
} else {
|
|
msg = msgIncludesOrMsg;
|
|
}
|
|
} else {
|
|
msg = errorClassOrMsg;
|
|
}
|
|
let doesThrow = false;
|
|
const msgSuffix = msg ? `: ${msg}` : ".";
|
|
try {
|
|
fn();
|
|
} catch (error) {
|
|
if (ErrorClass) {
|
|
if (error instanceof Error === false) {
|
|
throw new AssertionError(`A non-Error object was thrown${msgSuffix}`);
|
|
}
|
|
assertIsError(
|
|
error,
|
|
ErrorClass,
|
|
msgIncludes,
|
|
msg,
|
|
);
|
|
}
|
|
err = error;
|
|
doesThrow = true;
|
|
}
|
|
if (!doesThrow) {
|
|
msg = `Expected function to throw${msgSuffix}`;
|
|
throw new AssertionError(msg);
|
|
}
|
|
return err;
|
|
}
|