Class ApiError

Hierarchy

Error
- ApiError

Index

Constructors

Properties

body cause? message name request stack? status statusText url prepareStackTrace? stackTraceLimit

Methods

captureStackTrace isError

Constructors

constructor

new ApiError(
    request: ApiRequestOptions,
    response: ApiResult,
    message: string,
): ApiError
Parameters
- request: ApiRequestOptions
- response: ApiResult
- message: string
Returns ApiError
Overrides Error.constructor
- Defined in integrations/npm/api-client-fetch/src/http/generated/core/ApiError.ts:11

Properties

`Readonly`body

body: unknown

`Optional`cause

cause?: unknown

The cause of the error.

message

message: string

name

name: string

`Readonly`request

request: ApiRequestOptions

`Optional`stack

stack?: string

`Readonly`status

status: number

`Readonly`statusText

statusText: string

`Readonly`url

url: string

`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

The maximum number of stack frames to capture.

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 Error.captureStackTrace
- Defined in node_modules/bun-types/globals.d.ts:958
captureStackTrace(targetObject: object, constructorOpt?: Function): void
Create .stack property on a target object
Parameters
- targetObject: object
- OptionalconstructorOpt: Function
Returns void
Inherited from Error.captureStackTrace
- Defined in node_modules/@types/node/globals.d.ts:136

`Static`isError

isError(value: unknown): value is Error
Check if a value is an instance of Error
Parameters
- value: unknown
  The value to check
Returns value is Error
True if the value is an instance of Error, false otherwise
Inherited from Error.isError
- Defined in node_modules/bun-types/globals.d.ts:953