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.



  • Parameters

    Returns GraphQLError

  • Deprecated

    Please use the GraphQLErrorOptions constructor overload instead.


    • message: string
    • Optional nodes: ASTNode | readonly ASTNode[]
    • Optional source: Source
    • Optional positions: readonly number[]
    • Optional path: readonly (string | number)[]
    • Optional originalError: Error & {
          extensions?: unknown;
    • Optional extensions: GraphQLErrorExtensions

    Returns GraphQLError


Extension fields to add to the formatted error.

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

message: string
name: string
nodes: readonly ASTNode[]

An array of GraphQL AST Nodes corresponding to this error.

originalError: Error

The original error thrown from a field resolver during execution.

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

positions: readonly number[]

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

source: 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.

stack?: string
prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

stackTraceLimit: number


  • get [toStringTag](): string
  • Returns string


  • Returns string

  • Create .stack property on a target object


    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Generated using TypeDoc