ApiError | iland-sdk

Wrapper for iland API errors.

Hierarchy

Error
- ApiError

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ApiError(_json: ApiErrorJson): ApiError

- Defined in config/api-error.ts:4
Constructor.

Parameters
- _json: ApiErrorJson
  
  error JSON from the API
Returns ApiError

Properties

message

message: string

name

name: string

Optional stack

stack: undefined | string

Static Error

Error: ErrorConstructor

Methods

getDetailMessage

getDetailMessage(): string | null

- Defined in config/api-error.ts:27
Gets the error detail message.

Returns string | null

detailed message or null if none exists

getJson

getJson(): ApiErrorJson

- Defined in config/api-error.ts:51
Gets the raw JSON object from the API.

Returns ApiErrorJson

the API Error JSON object

getMessage

getMessage(): string

- Defined in config/api-error.ts:19
Gets the error message.

Returns string

getType

getType(): ApiErrorType

- Defined in config/api-error.ts:35
Gets the error type.

Returns ApiErrorType

the type of API error

toString

toString(): string

- Defined in config/api-error.ts:43
JSON format.

Returns string

Generated using TypeDoc