Skip to main content

@dialstack/sdk-dev / js/src / ApiError

Class: ApiError

Defined in: sdk/js/src/core/instance.ts:93

Error thrown by SDK API calls, carrying the HTTP status code.

Extends​

  • Error

Constructors​

Constructor​

TypeScript
new ApiError(
   message, 
   status, 
   code?): ApiError;

Defined in: sdk/js/src/core/instance.ts:94

Parameters​

message​

string

status​

number

code?​

string

Stable machine-readable code from the API body ({ "code": "..." }), when present.

Returns​

ApiError

Overrides​

TypeScript
Error.constructor

Properties​

code?​

TypeScript
readonly optional code?: string;

Defined in: sdk/js/src/core/instance.ts:98

Stable machine-readable code from the API body ({ "code": "..." }), when present.

message​

TypeScript
message: string;

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from​

TypeScript
Error.message

name​

TypeScript
name: string;

Defined in: docs/node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from​

TypeScript
Error.name

stack?​

TypeScript
optional stack?: string;

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

Inherited from​

TypeScript
Error.stack

status​

TypeScript
readonly status: number;

Defined in: sdk/js/src/core/instance.ts:96

stackTraceLimit​

TypeScript
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​

TypeScript
Error.stackTraceLimit

Methods​

captureStackTrace()​

TypeScript
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.

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

JavaScript
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​

TypeScript
Error.captureStackTrace

prepareStackTrace()​

TypeScript
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​

TypeScript
Error.prepareStackTrace
On this page