Class AssertionFatal<T>

This error is thrown when the fatal assertion check is thrown within the module.

Extends standard Error class
- AssertionError is a base class of this error
  - AssertionFailure Used for normal assertion failures
    - AssertionFatal - This class

Param: message

The message for the error.

Param: props

The additional properties for the error.

Param: stackStart

The function to use as the starting point for the stack trace.

Returns

The new AssertionFatal.

Example

  * try {
  *   throw new AssertionFatal("Assertion failed - not implemented", { expected: 1, actual: 2 });
  * } catch (e) {
  *  console.error(e.fullStack);
  *  console.log(e.toJSON());
  * }
  *

Type Parameters

T
The type of the additional properties.

AssertionFatal<T>(
    message?: string,
    props?: T,
    stackStart?: Function | Function[],
): AssertionFatal<T>
Static
Creates a new AssertionFatal with the given message and properties.
Type Parameters
- T
  The type of the additional properties.
Parameters
- Optionalmessage: string
  The message for the error.
- Optionalprops: T
  The additional properties for the error.
- OptionalstackStart: Function | Function[]
  The function to use as the starting point for the stack trace.
Returns AssertionFatal<T>
The new AssertionFatal.
Example
```
try {
  throw new AssertionFatal("Assertion failed - not implemented", { expected: 1, actual: 2 });
} catch (e) {
 console.error(e.fullStack);
 console.log(e.toJSON());
}
```
- Defined in assert/assertionError.ts:568
- Defined in assert/assertionError.ts:694
AssertionFatal<T>(
    message?: string,
    innerEx?: Error,
    props?: T,
    stackStart?: Function | Function[],
): AssertionFatal<T>
Static
Creates a new AssertionFatal with the given message and properties.
Type Parameters
- T
  The type of the additional properties.
Parameters
- Optionalmessage: string
  The message for the error.
- OptionalinnerEx: Error
  The error that caused this error to be thrown.
- Optionalprops: T
  The additional properties for the error.
- OptionalstackStart: Function | Function[]
  The function to use as the starting point for the stack trace.
Returns AssertionFatal<T>
The new AssertionFatal.
Example
```
try {
  throw new AssertionFatal("Assertion failed - not implemented", new Error(), { expected: 1, actual: 2 });
} catch (e) {
 console.error(e.fullStack);
 console.log(e.toJSON());
}
```
- Defined in assert/assertionError.ts:568
- Defined in assert/assertionError.ts:694
AssertionFatal<T>(
    message?: string,
    props?: T,
    stackStart?: Function | Function[],
): AssertionFailure<T>
Static Hideconstructor
Creates a new AssertionFailure with the given message and properties.
Type Parameters
- T
  The type of the additional properties.
Parameters
- Optionalmessage: string
  The message for the error.
- Optionalprops: T
  The additional properties for the error.
- OptionalstackStart: Function | Function[]
  The function to use as the starting point for the stack trace.
Returns AssertionFailure<T>
The new AssertionFailure.
Example
```
try {
   throw new AssertionFailure("Assertion failed", { expected: 1, actual: 2 });
} catch (e) {
  console.error(e.fullStack);
 console.log(e.toJSON());
}
```
- Defined in assert/assertionError.ts:568
- Defined in assert/assertionError.ts:694
AssertionFatal<T>(
    message?: string,
    innerEx?: Error,
    props?: T,
    stackStart?: Function | Function[],
): AssertionFailure<T>
Static Hideconstructor
Creates a new AssertionFailure with the given message and properties.
Type Parameters
- T
  The type of the additional properties.
Parameters
- Optionalmessage: string
  The message for the error.
- OptionalinnerEx: Error
  The error that caused this error to be thrown.
- Optionalprops: T
  The additional properties for the error.
- OptionalstackStart: Function | Function[]
  The function to use as the starting point for the stack trace.
Returns AssertionFailure<T>
The new AssertionFailure.
Example
```
try {
   throw new AssertionFailure("Assertion failed", new Error(), { expected: 1, actual: 2 });
} catch (e) {
  console.error(e.fullStack);
 console.log(e.toJSON());
}
```
- Defined in assert/assertionError.ts:568
- Defined in assert/assertionError.ts:694
AssertionFatal<T>(
    message?: string,
    props?: T,
    stackStart?: Function | Function[],
): AssertionError<T>
Static
Creates a new AssertionError with the given message and properties.
Type Parameters
- T
  The type of the additional properties.
Parameters
- Optionalmessage: string
  The message for the error.
- Optionalprops: T
  The additional properties for the error.
- OptionalstackStart: Function | Function[]
  An array of possible functions to use as the starting point for the stack trace.
Returns AssertionError<T>
The new AssertionError.
- Defined in assert/assertionError.ts:568
- Defined in assert/assertionError.ts:694
AssertionFatal<T>(
    message?: string,
    innerEx?: Error,
    props?: T,
    stackStart?: Function | Function[],
): AssertionError<T>
Static
Creates a new AssertionError with the given message and properties.
Type Parameters
- T
  The type of the additional properties.
Parameters
- Optionalmessage: string
  The message for the error.
- OptionalinnerEx: Error
  The error that caused this error to be thrown.
- Optionalprops: T
  The additional properties for the error.
- OptionalstackStart: Function | Function[]
  An array of possible functions to use as the starting point for the stack trace.
Returns AssertionError<T>
The new AssertionError.
- Defined in assert/assertionError.ts:568
- Defined in assert/assertionError.ts:694
AssertionFatal(message?: string): AssertionError
Static
Parameters
- Optionalmessage: string
Returns AssertionError
- Defined in assert/assertionError.ts:568
- Defined in assert/assertionError.ts:694
AssertionFatal(message?: string): Error
Static
Parameters
- Optionalmessage: string
Returns Error
- Defined in assert/assertionError.ts:568
- Defined in assert/assertionError.ts:694

Index

Properties

message

message: string

name

name: string

`Optional` `Readonly`props

props?: T

Additional properties that are included in the error.

`Optional`stack

stack?: string

`Static`stackTraceLimit

stackTraceLimit: number

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Accessors

`Static`fullStack

get fullStack(): string
Gets the full stack trace of the error, this will show all of the internal calls that lead to the error being thrown. Useful for debugging as generally the stack trace will only show the location where the error was thrown.

Returns string
The full stack trace as a string.
- Defined in assert/assertionError.ts:101

`Static`innerException

get innerException(): Error
The error that caused this error to be thrown.

Returns Error
- Defined in assert/assertionError.ts:106

Methods

`Static`captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.
```
const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`
```
The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:
```
function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();
```
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
- Defined in ../../common/temp/node_modules/@types/node/globals.d.ts:145

`Static`prepareStackTrace

prepareStackTrace(err: Error, stackTraces: CallSite[]): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
See
https://v8.dev/docs/stack-trace-api#customizing-stack-traces
- Defined in ../../common/temp/node_modules/@types/node/globals.d.ts:149

`Static`toJSON

toJSON(stack?: boolean): any
Converts the error to a JSON object.
Parameters
- Optionalstack: boolean
  Whether to include the stack trace in the JSON object.
Returns any
A JSON representation of the error.
- Defined in assert/assertionError.ts:114

Class AssertionFatal<T>

Param: message

Param: props

Param: stackStart

Returns

Example

Type Parameters

Type Parameters

Parameters

Returns AssertionFatal<T>

Example

Type Parameters

Parameters

Returns AssertionFatal<T>

Example

Type Parameters

Parameters

Returns AssertionFailure<T>

Example

Type Parameters

Parameters

Returns AssertionFailure<T>

Example

Type Parameters

Parameters

Returns AssertionError<T>

Type Parameters

Parameters

Returns AssertionError<T>

Parameters

Returns AssertionError

Parameters

Returns Error

Index

Properties

Accessors

Methods

Properties

message

name

Optional Readonlyprops

Optionalstack

StaticstackTraceLimit

Accessors

StaticfullStack

Returns string

StaticinnerException

Returns Error

Methods

StaticcaptureStackTrace

Parameters

Returns void

StaticprepareStackTrace

Parameters

Returns any

See

StatictoJSON

Parameters

Returns any

Settings

On This Page

`Optional` `Readonly`props

`Optional`stack

`Static`stackTraceLimit

`Static`fullStack

`Static`innerException

`Static`captureStackTrace

`Static`prepareStackTrace

`Static`toJSON