mirror of
https://github.com/denoland/std.git
synced 2024-11-21 20:50:22 +00:00
22 lines
604 B
TypeScript
22 lines
604 B
TypeScript
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.
|
|
// This module is browser compatible.
|
|
import { AssertionError } from "./assertion_error.ts";
|
|
|
|
/**
|
|
* Forcefully throws a failed assertion.
|
|
*
|
|
* @example Usage
|
|
* ```ts no-eval
|
|
* import { fail } from "@std/assert/fail";
|
|
*
|
|
* fail("Deliberately failed!"); // Throws
|
|
* ```
|
|
*
|
|
* @param msg Optional message to include in the error.
|
|
* @returns Never returns, always throws.
|
|
*/
|
|
export function fail(msg?: string): never {
|
|
const msgSuffix = msg ? `: ${msg}` : ".";
|
|
throw new AssertionError(`Failed assertion${msgSuffix}`);
|
|
}
|