Type Alias Error

An error object.

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

Properties

code detail? meta? title

Properties

code: string

The error code.

detail?: string

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

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

Additional properties relating to the error.

Type declaration

  • Optionalsource?: { parameter?: string; pointer?: string }

    References to the source of the error.

    • 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