Class AssertionError

The default error class that is thrown if an assertion fails.

Hierarchy

Error
- AssertionError

Index

Constructors

Properties

code message name stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new AssertionError(options: {
message: string;
}): AssertionError
Parameters
- options: {
  message: string;
  }
  - message: string
Returns AssertionError
Overrides Error.constructor
- Defined in src/assert.ts:64

Properties

`Readonly` code

code: "ERR_ASSERTION" = 'ERR_ASSERTION'

message

message: string

name

name: string

`Optional` stack

stack?: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Optional override for formatting stack traces
  
  See
  https://v8.dev/docs/stack-trace-api#customizing-stack-traces
  Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4