ApiError

21 min

ODP Node SDK / Zaius / ApiError

ApiError

Hierarchy

HttpError.ApiError

Index

Constructors

constructor()

Signature

new ApiError(source: HttpError): ApiError;

Parameters

Name	Type
source	HttpError

Returns

ApiError

Overrides: HttpError.constructor

Defined in: src/Api/lib/ApiError.ts:4

Properties

code?

string

Inherited from: HttpError.code

Defined in: src/Api/lib/ApiV3.ts:95

message

string

Inherited from: HttpError.message

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1041

name

string

Inherited from: HttpError.name

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1040

response?

HttpResponse<V3ErrorResponse>

Inherited from: HttpError.response

Defined in: src/Api/lib/ApiV3.ts:95

stack?

string

Inherited from: HttpError.stack

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1042

prepareStackTrace?

Function

Type declaration

Optional override for formatting stack traces

See

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

Signature

(err: Error, stackTraces: CallSite[]): any;

Parameters

Name	Type
err	Error
stackTraces	CallSite[]

Returns

any

Inherited from: HttpError.prepareStackTrace

Defined in: node_modules/@types/node/globals.d.ts:11

stackTraceLimit

Static number

Inherited from: HttpError.stackTraceLimit

Defined in: node_modules/@types/node/globals.d.ts:13

Methods

captureStackTrace()

Create .stack property on a target object

Signature

Static captureStackTrace(targetObject: object, constructorOpt?: Function): void;

Parameters

Name	Type
targetObject	object
constructorOpt?	Function

Returns

void

Inherited from: HttpError.captureStackTrace

Defined in: node_modules/@types/node/globals.d.ts:4