Interface GraphQLErrorExtended

GraphQL error extended interface based on PostGraphile and the Mosaic library

Hierarchy

Properties

extensions locations message nodes originalError path positions source

Properties

extensions

extensions: {
    exception: {
        code: string;
        detail?: string;
        hint?: string;
    };
    timestamp: string;
    [key: string]: any;
}

Extended Information for the (PostGraphile based) error

Type declaration

  • [key: string]: any
  • exception: {
        code: string;
        detail?: string;
        hint?: string;
    }
    • code: string
    • Optional detail?: string
    • Optional hint?: string
  • timestamp: string

    The timestamp when the error was raised

Readonly locations

locations: undefined | readonly {
    column: number;
    line: number;
}[]

An array of { line, column } locations within the source GraphQL document which correspond to this error.

Errors during validation often contain multiple locations, for example to point out two things with the same name. Errors during execution include a single location, the field which produced the error.

Enumerable, and appears in the result of JSON.stringify().

message

message: string

A message describing the Error for debugging purposes.

Enumerable, and appears in the result of JSON.stringify().

Note: should be treated as readonly, despite invariant usage.

Readonly nodes

nodes: undefined | readonly unknown[]

An array of GraphQL AST Nodes corresponding to this error.

Readonly originalError

originalError: undefined | null | Error

The original error thrown from a field resolver during execution.

Readonly path

path: undefined | readonly (string | number)[]

An array describing the JSON-path into the execution response which corresponds to this error. Only included for errors during execution.

Enumerable, and appears in the result of JSON.stringify().

Readonly positions

positions: undefined | readonly number[]

An array of character offsets within the source GraphQL document which correspond to this error.

Readonly source

source: undefined | {
    body: string;
    locationOffset: {
        column: number;
        line: number;
    };
    name: string;
}

The source GraphQL document corresponding to this error.

Note that if this Error represents more than one node, the source may not represent nodes after the first node.

Type declaration

  • body: string
  • locationOffset: {
        column: number;
        line: number;
    }
    • Readonly column: number
    • Readonly line: number
  • name: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc