Class AssertionError

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

Hierarchy

  • Error
    • AssertionError

Constructors

constructor

Properties

actual cause? code expected generatedMessage message name operator stack? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

  • new AssertionError(
        options?: {
            actual?: unknown;
            expected?: unknown;
            message?: string;
            operator?: string;
            stackStartFn?: Function;
        },
    ): assert.AssertionError

  • Parameters

    • Optionaloptions: {
          actual?: unknown;
          expected?: unknown;
          message?: string;
          operator?: string;
          stackStartFn?: Function;
      }
      • Optionalactual?: unknown

        The actual property on the error instance.

      • Optionalexpected?: unknown

        The expected property on the error instance.

      • Optionalmessage?: string

        If provided, the error message is set to this value.

      • Optionaloperator?: string

        The operator property on the error instance.

      • OptionalstackStartFn?: Function

        If provided, the generated stack trace omits frames before this function.

    Returns assert.AssertionError

Properties

actual

actual: unknown

Set to the actual argument for methods such as ().

Optionalcause

cause?: unknown

code

code: "ERR_ASSERTION"

Value is always ERR_ASSERTION to show that the error is an assertion error.

expected

expected: unknown

Set to the expected argument for methods such as ().

generatedMessage

generatedMessage: boolean

Indicates if the message was auto-generated (true) or not.

message

message: string

name

name: string

operator

operator: string

Set to the passed in operator value.

Optionalstack

stack?: string

Static OptionalprepareStackTrace

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

Optional override for formatting stack traces

See

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

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

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

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods