Skip to main content

@dialstack/sdk / server / DialStackRateLimitError

Class: DialStackRateLimitError

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

Rate limit exceeded (429)

Extends​

Constructors​

Constructor​

new DialStackRateLimitError(message, options): DialStackRateLimitError;

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

Parameters​

message​

string

options​

object & object

Returns​

DialStackRateLimitError

Overrides​

DialStackError.constructor

Properties​

code?​

readonly optional code?: string;

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

Inherited from​

DialStackError.code

docUrl?​

readonly optional docUrl?: string;

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

Inherited from​

DialStackError.docUrl

message​

message: string;

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

Inherited from​

DialStackError.message

name​

name: string;

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

Inherited from​

DialStackError.name

param?​

readonly optional param?: string;

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

Inherited from​

DialStackError.param

raw?​

readonly optional raw?: RawError;

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

Inherited from​

DialStackError.raw

requestId?​

readonly optional requestId?: string;

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

Inherited from​

DialStackError.requestId

retryAfter?​

readonly optional retryAfter?: number;

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

stack?​

optional stack?: string;

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

Inherited from​

DialStackError.stack

statusCode​

readonly statusCode: number;

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

Inherited from​

DialStackError.statusCode

type​

readonly type: RawErrorType;

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

Inherited from​

DialStackError.type

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​

DialStackError.stackTraceLimit

Methods​

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​

DialStackError.captureStackTrace

generate()​

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

Inherited from​

DialStackError.generate

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​

DialStackError.prepareStackTrace