Class ApiError<Code, Body>

Type Parameters

Code extends number = number
Body = unknown

Hierarchy (view full)

SdkError
- ApiError

Index

Constructors

Properties

cause? errorCode message name response responseBody stack? statusCode prepareStackTrace? stackTraceLimit

Methods

captureStackTrace unknown

Constructors

constructor

new ApiError<Code, Body>(message, body, statusCode, errorCode, response): ApiError<Code, Body>
Type Parameters
- Code extends number = number
- Body = unknown
Parameters
- message: string
- body: Body
- statusCode: Code
- errorCode: string
- response: Response
Returns ApiError<Code, Body>
Overrides SdkError.constructor
- Defined in src/errors/apiErrors.ts:40

Properties

`Optional` cause

cause?: unknown

`Readonly` errorCode

errorCode: string

message

message: string

name

name: string

`Readonly` response

response: Response

`Readonly` responseBody

responseBody: Body

`Optional` stack

stack?: string

`Readonly` statusCode

statusCode: Code

`Static` `Optional` prepareStackTrace

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

Optional override for formatting stack traces

Type declaration

- (err, stackTraces): any
- 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 SdkError.captureStackTrace
- Defined in node_modules/.pnpm/@types+node@20.11.30/node_modules/@types/node/globals.d.ts:21

`Static` unknown

unknown(response): ApiError<number, undefined>
Parameters
- response: Response
Returns ApiError<number, undefined>
- Defined in src/errors/apiErrors.ts:48