Modules

Class AssertionError

Indicates the failure of an assertion. All errors thrown by the assert module will be instances of the AssertionError class.

Hierarchy

Error
- AssertionError

Constructors

constructor

Properties

Methods

captureStackTrace

Constructors

constructor

new AssertionError(options?: object): AssertionError

Overrides Error.constructor
- Defined in node_modules/@types/node/assert.d.ts:23
Parameters
- Optional options: object
  - Optional actual?: unknown
    
    The actual property on the error instance.
  - Optional expected?: unknown
    
    The expected property on the error instance.
  - Optional message?: string
    
    If provided, the error message is set to this value.
  - Optional operator?: string
    
    The operator property on the error instance.
  - Optional stackStartFn?: Function
    
    If provided, the generated stack trace omits frames before this function.
Returns AssertionError

Properties

actual

actual: unknown

code

code: "ERR_ASSERTION"

expected

expected: unknown

generatedMessage

generatedMessage: boolean

message

message: string

name

name: string

operator

operator: string

Optional stack

stack: string

Static Optional prepareStackTrace

prepareStackTrace: function

Optional override for formatting stack traces

see: https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Type declaration

- (err: Error, stackTraces: CallSite[]): any
- Parameters
  - err: Error
  - stackTraces: CallSite[]
  Returns any

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

captureStackTrace(targetObject: object, constructorOpt?: Function): void

Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4
Create .stack property on a target object

Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void

Generated using TypeDoc