Class APIError

Hierarchy

Error
- APIError

Index

Constructors

Properties

cause? error errorType message name referenceUrl reportUrl response stack? status trace prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new APIError(response): APIError
Parameters
- response: APIResponseData
Returns APIError
Overrides Error.constructor
- Defined in src/v4/core/api.ts:56

Properties

`Optional` cause

cause?: unknown

`Readonly` error

error: string

`Readonly` errorType

errorType: string

message

message: string

name

name: string

`Readonly` referenceUrl

referenceUrl: string

`Readonly` reportUrl

reportUrl: string

`Readonly` response

response: APIResponseData

`Optional` stack

stack?: string

`Readonly` status

status: number

`Readonly` trace

trace: string

`Static` `Optional` prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

- (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

`Static` stackTraceLimit

stackTraceLimit: number

Methods

`Static` captureStackTrace

captureStackTrace(targetObject, constructorOpt?): void
Create .stack property on a target object
Parameters
- targetObject: object
- Optional constructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:4

Generated using TypeDoc