Abstract Class: BaseException

Base exception class for all SDK exceptions. Provides structured error information for better debugging and error handling.

Extends

  • Error

Constructors

Constructor

new BaseException(message, code, context?, cause?): BaseException

Parameters

======= message

string

======= code

string

======= context?

Record<string, unknown>

======= cause?

Error

Returns

BaseException

Overrides

Error.constructor

Properties

cause?

readonly optional cause?: Error


code

readonly code: string


context?

readonly optional context?: Record<string, unknown>


message

readonly message: string

Inherited from

Error.message


name

name: string

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.name


stack?

readonly optional stack?: string

Overrides

Error.stack


timestamp

readonly timestamp: Date


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

is()

is<T>(exceptionClass): this is T

Check if this exception is of a specific type.

Type Parameters

======= T

T extends BaseException

Parameters

======= exceptionClass

(…args) => T

Returns

this is T


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.

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

======= constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace


prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

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

Parameters

======= err

Error

======= stackTraces

CallSite[]

Returns

any

Inherited from

Error.prepareStackTrace