Class APIConnectionError

Hierarchy (View Summary)

APIError<undefined, undefined, undefined>
- APIConnectionError
  - APIConnectionTimeoutError

Index

Constructors

Properties

error headers message name stack? status prepareStackTrace? stackTraceLimit

Methods

captureStackTrace generate

Constructors

constructor

new APIConnectionError(
__namedParameters: { cause?: Error; message?: string },
): APIConnectionError
Parameters
- __namedParameters: { cause?: Error; message?: string }
Returns APIConnectionError
Overrides APIError.constructor
- Defined in src/core/error.ts:102

Properties

`Readonly`error

error: undefined

JSON body of the response that caused the error

`Readonly`headers

headers: undefined

HTTP headers for the response that caused the error

message

message: string

name

name: string

`Optional`stack

stack?: string

`Readonly`status

status: undefined

HTTP status for the response that caused the error

`Static` `Optional`prepareStackTrace

prepareStackTrace?: (err: Error, stackTraces: CallSite[]) => any

Optional override for formatting stack traces

See

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

`Static`stackTraceLimit

stackTraceLimit: number

Methods

`Static`captureStackTrace

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

`Static`generate

generate(
    status: undefined | number,
    errorResponse: undefined | Object,
    message: undefined | string,
    headers: undefined | Headers,
): APIError
Parameters
- status: undefined | number
- errorResponse: undefined | Object
- message: undefined | string
- headers: undefined | Headers
Returns APIError
Inherited from APIError.generate
- Defined in src/core/error.ts:47