Type Alias Error

An error object.

type Error = {
    code: string;
    detail?: string;
    meta?: unknown;
    source?: { parameter?: string; pointer?: string };
    title: string;
}
Index

Properties

code detail? meta? source? title

Properties

code: string

The error code.

detail?: string

A human-readable explanation specific to this occurrence of the problem.

meta?: unknown

Additional properties relating to the error.

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

References to the source of the error.

Type Declaration

  • Optionalparameter?: string

    The URI query parameter that caused the error.

  • Optionalpointer?: string

    A JSON Pointer to the property that caused the error.

title: string

Summary of the problem.

Settings

Member Visibility

On This Page

Properties