Class ApiRequestError

Describes errors thrown during api requests.

Hierarchy

ApiError
- ApiRequestError

Index

Constructors

Properties

data? message name stack? status? prepareStackTrace? stackTraceLimit

Methods

captureStackTrace

Constructors

constructor

new ApiRequestError(message?, status?, error?): ApiRequestError
Parameters
- Optional message: string
  Description of the error.
- Optional status: number
  HTTP status code of the error response, if relevant.
- Optional error: any
  The originating error, if relevant.
Returns ApiRequestError
Overrides ApiError.constructor

Properties

`Optional` data

data?: any

Additional data provided as part of the error.

message

message: string

name

name: string

`Optional` stack

stack?: string

`Optional` status

status?: number

Response HTTP status code (if provided).

`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 ApiError.captureStackTrace

Generated using TypeDoc