Options
All
  • Public
  • Public/Protected
  • All
Menu

Class 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

Methods

Constructors

constructor

  • new GraphQLError(message: string, nodes?: ASTNode | readonly ASTNode[], source?: Source, positions?: readonly number[], path?: readonly (string | number)[], originalError?: Error, extensions?: {}): GraphQLError

  • Parameters

    • message: string
    • Optional nodes: ASTNode | readonly ASTNode[]
    • Optional source: Source
    • Optional positions: readonly number[]
    • Optional path: readonly (string | number)[]
    • Optional originalError: Error
    • Optional extensions: {}
      • [key: string]: any

    Returns GraphQLError

Properties

Readonly extensions

extensions: {}

Extension fields to add to the formatted error.

Type declaration

  • [key: string]: any

Readonly locations

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

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.

name

name: string

Readonly nodes

nodes: readonly ASTNode[]

An array of GraphQL AST Nodes corresponding to this error.

Readonly originalError

originalError: Error

The original error thrown from a field resolver during execution.

Readonly path

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

Readonly positions

positions: readonly number[]

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

Readonly source

source: Source

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.

Optional stack

stack?: string

Static stackTraceLimit

stackTraceLimit: number

Methods

Static captureStackTrace

  • captureStackTrace(targetObject: <internal>.Object, constructorOpt?: Function): void

  • Create .stack property on a target object

    Parameters

    Returns void

Static Optional prepareStackTrace

  • prepareStackTrace(err: Error, stackTraces: CallSite[]): any

Generated using TypeDoc