Connect SDK

Appearance

@swapped/connect-sdk / core / ConnectSdkApiError

Class: ConnectSdkApiError ​

Defined in: src/errors/connect-sdk-api-error.ts:43

Normalized error thrown for failed Swapped API requests.

Extends ​

Constructors ​

Constructor ​

new ConnectSdkApiError(error): ConnectSdkApiError

Defined in: src/errors/connect-sdk-api-error.ts:47

Parameters ​

error ​

ConnectSdkApiErrorInput

Returns ​

ConnectSdkApiError

Overrides ​

ConnectSdkError.constructor

Methods ​

toJSON() ​

toJSON(): object

Defined in: src/errors/connect-sdk-error.ts:53

Returns ​

object

code ​

code: ConnectSdkErrorCode

details? ​

optional details?: Record<string, unknown>

message ​

message: string

name ​

name: string

Inherited from ​

ConnectSdkError.toJSON

Properties ​

apiCode? ​

readonly optional apiCode?: string

Defined in: src/errors/connect-sdk-api-error.ts:45

cause? ​

readonly optional cause?: unknown

Defined in: src/errors/connect-sdk-error.ts:30

Inherited from ​

ConnectSdkError.cause

code ​

readonly code: ConnectSdkErrorCode

Defined in: src/errors/connect-sdk-error.ts:28

Inherited from ​

ConnectSdkError.code

details? ​

readonly optional details?: Record<string, unknown>

Defined in: src/errors/connect-sdk-error.ts:29

Inherited from ​

ConnectSdkError.details

messageKey ​

readonly messageKey: string

Defined in: src/errors/connect-sdk-error.ts:31

Inherited from ​

ConnectSdkError.messageKey

messageParams? ​

readonly optional messageParams?: TranslateParams

Defined in: src/errors/connect-sdk-error.ts:32

Inherited from ​

ConnectSdkError.messageParams

rawMessage? ​

readonly optional rawMessage?: string

Defined in: src/errors/connect-sdk-error.ts:33

Inherited from ​

ConnectSdkError.rawMessage

status ​

readonly status: string | number

Defined in: src/errors/connect-sdk-api-error.ts:44