Skip to main content

Class: ApiError

Defined in: core/src/ApiError.ts:8

Describes an error that originates from a API service. This class extends the standard Error class to include a unique code that can be used to trace an error to source code as well as the HTTP response status returned with the error.

Extends​

  • Error

Constructors​

Constructor​

new ApiError(code, status, message?, templateVariables?): ApiError

Defined in: core/src/ApiError.ts:24

Parameters​

code​

string

status​

number

message?​

string

templateVariables?​

any

Returns​

ApiError

Overrides​

Error.constructor

Properties​

code​

code: string

Defined in: core/src/ApiError.ts:10

The unique code of the error.

message​

message: string

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

Inherited from​

Error.message

name​

name: string

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

Inherited from​

Error.name

stack?​

optional stack?: string

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

Inherited from​

Error.stack

status​

status: number

Defined in: core/src/ApiError.ts:12

The HTTP status associated with the error.

stackTraceLimit​

static stackTraceLimit: number

Defined in: core/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​

ApiMessageTemplate()​

ApiMessageTemplate(message, templateVariables?): string

Defined in: core/src/ApiError.ts:14

Parameters​

message​

string | undefined

templateVariables?​

any

Returns​

string

captureStackTrace()​

static captureStackTrace(targetObject, constructorOpt?): void

Defined in: core/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: core/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​

Error.prepareStackTrace