Class ApiXResponseError

An error object that can be returned by an API-X endpoint.

Hierarchy (View Summary)

Error
- ApiXResponseError

Index

Constructors

Properties

Constructors

constructor

new ApiXResponseError(
    id: string,
    statusCode: number,
    message?: string,
): ApiXResponseError
Creates a new instance of an API-X Error.
Parameters
- id: string
  The error ID.
- statusCode: number
- Optionalmessage: string
Returns ApiXResponseError
Overrides Error.constructor
- Defined in client/error/ApiXResponseError.ts:78

Properties

`Readonly`id

id: string

The error ID.

`Readonly`statusCode

statusCode: number

The HTTP status code associated with the error. This is optional and can be used to provide additional context.