Class SDKError

Custom error class thrown by all SDK methods on failure.

All rejected promises from API calls reject with an instance of this class.

Hierarchy

Error
- SDKError

Index

Constructors

Methods

Properties

Constructors

constructor

new SDKError(message: string, errorObject?: Record<string, unknown>): SDKError
Parameters
- message: string
  Human-readable error message
- OptionalerrorObject: Record<string, unknown>
  Optional server error payload. All enumerable properties are shallow-copied onto this instance.
Returns SDKError
Overrides Error.constructor

Methods

toString

toString(): string
Returns a multi-line string with the error name, message, and any other properties copied from the server error payload.

Returns string

Properties

`Optional`code

code?: number

HTTP status code from the server error payload; declared explicitly to allow numeric comparisons without type-casting.