Lupa

Appearance

Lupa API Reference / @pawel-up/lupa/assert / AssertionError

Class: AssertionError<T> ​

Defined in: node_modules/assertion-error/index.d.ts:7

Extends ​

  • Error

Type Parameters ​

T ​

T

Implements ​

  • Result

Indexable ​

[key: string]: unknown

Constructors ​

Constructor ​

new AssertionError<T>(message, props?, ssf?): AssertionError<T>

Defined in: node_modules/assertion-error/index.d.ts:13

Parameters ​

message ​

string

props? ​

T

ssf? ​

Function

Returns ​

AssertionError<T>

Overrides ​

Error.constructor

Properties ​

cause? ​

optional cause?: unknown

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from ​

Error.cause

message ​

message: string

Defined in: node_modules/assertion-error/index.d.ts:11

Overrides ​

Error.message

name ​

name: "AssertionError"

Defined in: node_modules/assertion-error/index.d.ts:9

Implementation of ​

Result.name

Overrides ​

Error.name

ok ​

ok: false

Defined in: node_modules/assertion-error/index.d.ts:10

Implementation of ​

Result.ok

stack ​

stack: string

Defined in: node_modules/assertion-error/index.d.ts:14

Overrides ​

Error.stack

stackTraceLimit ​

static stackTraceLimit: number

Defined in: node_modules/@types/node/globals.d.ts:67

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.

Inherited from ​

Error.stackTraceLimit

Methods ​

toJSON() ​

toJSON(stack?): Record<string, unknown>

Defined in: node_modules/assertion-error/index.d.ts:15

Parameters ​

stack? ​

boolean

Returns ​

Record<string, unknown>

Implementation of ​

Result.toJSON

captureStackTrace() ​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

js
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:

js
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

constructorOpt? ​

Function

Returns ​

void

Inherited from ​

Error.captureStackTrace

isError() ​

static isError(error): error is Error

Defined in: node_modules/typescript/lib/lib.esnext.error.d.ts:21

Indicates whether the argument provided is a built-in Error instance or not.

Parameters ​

error ​

unknown

Returns ​

error is Error

Inherited from ​

Error.isError

prepareStackTrace() ​

static prepareStackTrace(err, stackTraces): any

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters ​

err ​

Error

stackTraces ​

CallSite[]

Returns ​

any

See ​

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

Inherited from ​

Error.prepareStackTrace