Interface GraphqlErrorResponse

An error returned by GraphQL

See

GraphQL Spec

interface GraphqlErrorResponse {
    extensions?: JsonObject;
    locations?: { column: number; line: number }[];
    message: string;
    path?: (string | number)[];
}

Properties

extensions? locations? message path?

Properties

Optionalextensions

extensions?: JsonObject

Extra information about the error.

Will likely be ShipgeniusGraphqlErrorExtension

Optionallocations

locations?: { column: number; line: number }[]

Where the error occurred

Type declaration

  • column: number

    The column in the GraphQL document the error occurred

  • line: number

    The line in the GraphQL document the error occurred

message

message: string

The error message

Optionalpath

path?: (string | number)[]

The path of keys to where the error occurred

Settings

Member Visibility

On This Page

Properties