Class ApiError

Hierarchy

Error
- ApiError

Index

Constructors

Properties

code field? requestId? status?

Methods

isConflict isForbidden isNotFound isServerError isUnauthorised isValidation

Constructors

constructor

new ApiError(
    code: string,
    message: string,
    field?: string,
    requestId?: string,
    status?: number,
): ApiError
Parameters
- code: string
- message: string
- Optionalfield: string
- OptionalrequestId: string
- Optionalstatus: number
Returns ApiError
Overrides Error.constructor
- Defined in core/api-error.ts:4

Properties

`Readonly`code

code: string

`Optional` `Readonly`field

field?: string

`Optional` `Readonly`requestId

requestId?: string

`Optional` `Readonly`status

status?: number

Methods

isConflict

isConflict(): boolean
Returns boolean
- Defined in core/api-error.ts:17

isForbidden

isForbidden(): boolean
Returns boolean
- Defined in core/api-error.ts:19

isNotFound

isNotFound(): boolean
Returns boolean
- Defined in core/api-error.ts:20

isServerError

isServerError(): boolean
Returns boolean
- Defined in core/api-error.ts:22

isUnauthorised

isUnauthorised(): boolean
Returns boolean
- Defined in core/api-error.ts:18

isValidation

isValidation(): boolean
Returns boolean
- Defined in core/api-error.ts:21