Skip to main content

@dialstack/sdk / server / DialStackError

Class: DialStackError

Defined in: sdk/src/server/errors.ts:27

Base error class for all DialStack errors

Extends​

  • Error

Extended by​

Constructors​

Constructor​

TypeScript
new DialStackError(message, options): DialStackError;

Defined in: sdk/src/server/errors.ts:36

Parameters​

message​

string

options​
code?​

string

docUrl?​

string

param?​

string

raw?​

RawError

requestId?​

string

statusCode​

number

type?​

RawErrorType

Returns​

DialStackError

Overrides​

TypeScript
Error.constructor

Properties​

code?​

TypeScript
readonly optional code?: string;

Defined in: sdk/src/server/errors.ts:31

docUrl?​

TypeScript
readonly optional docUrl?: string;

Defined in: sdk/src/server/errors.ts:33

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

param?​

TypeScript
readonly optional param?: string;

Defined in: sdk/src/server/errors.ts:32

raw?​

TypeScript
readonly optional raw?: RawError;

Defined in: sdk/src/server/errors.ts:34

requestId?​

TypeScript
readonly optional requestId?: string;

Defined in: sdk/src/server/errors.ts:30

stack?​

TypeScript
optional stack?: string;

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

Inherited from​

TypeScript
Error.stack

statusCode​

TypeScript
readonly statusCode: number;

Defined in: sdk/src/server/errors.ts:29

type​

TypeScript
readonly type: RawErrorType;

Defined in: sdk/src/server/errors.ts:28

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

generate()​

TypeScript
static generate(
   message, 
   statusCode, 
   raw?, 
   requestId?): DialStackError;

Defined in: sdk/src/server/errors.ts:67

Generate appropriate error subclass based on status code and error type

Parameters​

message​

string

statusCode​

number

raw?​

RawError

requestId?​

string

Returns​

DialStackError

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