Skip to main content

GraphQLError

A GraphQLError describes an Error found during the parse, validate, or execute phases of performing a GraphQL operation. In addition to a message and stack trace, it also includes information about the locations in a GraphQL document and/or execution result that correspond to the Error.

Hierarchy

  • Error
    • GraphQLError

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new GraphQLError(message: string, args?: GraphQLErrorArgs): GraphQLError
  • new GraphQLError(message: string, nodes?: null | ASTNode | readonly ASTNode[], source?: Maybe<Source>, positions?: Maybe<readonly number[]>, path?: Maybe<readonly (string | number)[]>, originalError?: Maybe<Error & { extensions?: unknown }>, extensions?: Maybe<GraphQLErrorExtensions>): GraphQLError

  • Parameters

    • message: string
    • optionalargs: GraphQLErrorArgs

    Returns GraphQLError

Properties

readonlyextensions

extensions: GraphQLErrorExtensions

Extension fields to add to the formatted error.

readonlylocations

locations: undefined | readonly SourceLocation[]

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().

readonlynodes

nodes: undefined | readonly ASTNode[]

An array of GraphQL AST Nodes corresponding to this error.

readonlyoriginalError

originalError: undefined | Error

The original error thrown from a field resolver during execution.

readonlypath

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().

readonlypositions

positions: undefined | readonly number[]

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

readonlysource

source: undefined | Source

The source GraphQL document for the first location of this error.

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

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns string

Methods

toJSON

toString

  • toString(): string

  • Returns string