@augment-vir/assert/dist/augments/assertion.error.d.ts

A collection of assertions for test and production code alike.

/**
 * An error thrown by the `@augment-vir/assert` package when an assertion fails.
 *
 * This requires both a `baseMessage` (the default "this thing failed" error message defined inside
 * `@augment-vir/assert` for each assert method), and a possibly-undefined `userCustomizedMessage`
 * (the optional user-defined failure message for any assertion).
 *
 * @category Assert : Util
 * @category Package : @augment-vir/assert
 * @example
 *
 * ```ts
 * import {AssertionError} from '@augment-vir/assert';
 *
 * // the message from this error will be: `'User defined message: The assertion failed.'`
 * throw new AssertionError('The assertion failed.', 'User defined message.');
 * ```
 *
 * @package [`@augment-vir/assert`](https://www.npmjs.com/package/@augment-vir/assert)
 */
export declare class AssertionError extends Error {
    name: string;
    constructor(baseMessage: string, userCustomizedMessage: string | undefined);
}