Class JapiError

Constructors

Properties

code?: string

An application-specific error code, expressed as a string value.

detail?: string

A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

id?: string

A unique identifier for this particular occurrence of the problem.

links?: Dictionary<nullish | default>

A links object

meta?: default

A meta object containing non-standard meta information about the error.

source?: {
    parameter?: string;
    pointer?: string;
}

An object containing references to the source of the error, optionally including any of the following members.

Type declaration

  • Optional parameter?: string

    A string indicating which URI query parameter caused the error.

  • Optional pointer?: string

    A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. /data for a primary data object, or /data/attributes/title for a specific attribute].

stack: string
status?: string

The HTTP status code applicable to this problem, expressed as a string value.

title?: string

A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

Methods

Generated using TypeDoc