Class FailAssertionError

Variant of an AssertionError that is thrown when bupkis!expect.fail is called.

Hierarchy (View Summary)

AssertionError
- FailAssertionError

Index

Constructors

Methods

isAssertionError isFailAssertionError toJSON

Properties

assertionId name

Constructors

constructor

new FailAssertionError(options?: FailAssertionErrorOptions): FailAssertionError
Parameters
- Optionaloptions: FailAssertionErrorOptions
Returns FailAssertionError
Overrides AssertionError.constructor
- Defined in src/error.ts:198

Methods

`Static`isAssertionError

isAssertionError(value: unknown): value is AssertionError
Type guard for an instance of this error.
Parameters
- value: unknown
  Some value
Returns value is AssertionError
true if value is an instance of AssertionError
Inherited from AssertionError.isAssertionError
- Defined in src/error.ts:120

`Static`isFailAssertionError

isFailAssertionError(err: unknown): err is FailAssertionError
Parameters
- err: unknown
Returns err is FailAssertionError
- Defined in src/error.ts:202

toJSON

toJSON(): {
    actual: unknown;
    expected: unknown;
    message: string;
    name: string;
    stack: string
    | undefined;
}
Returns {
    actual: unknown;
    expected: unknown;
    message: string;
    name: string;
    stack: string | undefined;
}
Inherited from AssertionError.toJSON
- Defined in src/error.ts:126

Properties

`Readonly`assertionId

assertionId: LiteralStringUnion<"FAIL">

Assertion ID of the assertion that caused this error.

name

name: string = 'FailAssertionError'