Skip to content

ApiError

Extends

  • Error

Constructors

new ApiError()

new ApiError(request, response, message): ApiError

Parameters

request: ApiRequestOptions

response: ApiResult

message: string

Returns

ApiError

Overrides

Error.constructor

Defined in

packages/core/src/ApiError.ts:11

Properties

body

readonly body: unknown

Defined in

packages/core/src/ApiError.ts:8


cause?

optional cause: unknown

Inherited from

Error.cause

Defined in

node_modules/typescript/lib/lib.es2022.error.d.ts:24


message

message: string

Inherited from

Error.message

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1077


name

name: string

Inherited from

Error.name

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1076


request

readonly request: ApiRequestOptions

Defined in

packages/core/src/ApiError.ts:9


stack?

optional stack: string

Inherited from

Error.stack

Defined in

node_modules/typescript/lib/lib.es5.d.ts:1078


status

readonly status: number

Defined in

packages/core/src/ApiError.ts:6


statusText

readonly statusText: string

Defined in

packages/core/src/ApiError.ts:7


url

readonly url: string

Defined in

packages/core/src/ApiError.ts:5


prepareStackTrace()?

static optional prepareStackTrace: (err, stackTraces) => any

Optional override for formatting stack traces

Parameters

err: Error

stackTraces: CallSite[]

Returns

any

See

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

Inherited from

Error.prepareStackTrace

Defined in

node_modules/@types/node/globals.d.ts:28


stackTraceLimit

static stackTraceLimit: number

Inherited from

Error.stackTraceLimit

Defined in

node_modules/@types/node/globals.d.ts:30

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void

Create .stack property on a target object

Parameters

targetObject: object

constructorOpt?: Function

Returns

void

Inherited from

Error.captureStackTrace

Defined in

node_modules/@types/node/globals.d.ts:21