@vitabletech/gbp-sdk

---

Extends

• GBPApiError

Constructors

Constructor

new RateLimitError(message, options?): RateLimitError

Parameters

message

string

options?

any

Returns

RateLimitError

Overrides

GBPApiError.constructor

Properties

cause?

optional cause?: unknown

Inherited from

GBPApiError.cause

---

code?

readonly optional code?: string

Inherited from

GBPApiError.code

---

message

message: string

Inherited from

GBPApiError.message

---

method?

readonly optional method?: string

Inherited from

GBPApiError.method

---

name

name: string

Inherited from

GBPApiError.name

---

responseBody?

readonly optional responseBody?: any

Inherited from

GBPApiError.responseBody

---

stack?

optional stack?: string

Inherited from

GBPApiError.stack

---

status

readonly status: number

Inherited from

GBPApiError.status

---

url?

readonly optional url?: string

Inherited from

GBPApiError.url

---

stackTraceLimit

static stackTraceLimit: number

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

GBPApiError.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

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

GBPApiError.captureStackTrace

---

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

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

Inherited from

GBPApiError.prepareStackTrace