GraphQLError | /lib/error/index.d.ts | graphql_deno@v15.0.0

class GraphQLError

extends Error

import { GraphQLError } from "https://dotland.deno.dev/x/graphql_deno@v15.0.0/lib/error/index.d.ts";

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.

Constructors

new

GraphQLError(

message: string,

nodes?: ReadonlyArray<ASTNode> | ASTNode | undefined,

source?: Maybe<Source>,

positions?: Maybe<ReadonlyArray<number>>,

path?: Maybe<ReadonlyArray<string | number>>,

originalError?: Maybe<Error>,

extensions?: Maybe<{ [key: string]: any; }>,

)

Properties

readonly

extensions: { [key: string]: any; } | undefined

Extension fields to add to the formatted error.

readonly

locations: ReadonlyArray<SourceLocation> | undefined

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

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: ReadonlyArray<ASTNode> | undefined

An array of GraphQL AST Nodes corresponding to this error.

readonly

originalError: Maybe<Error>

The original error thrown from a field resolver during execution.

readonly

path: ReadonlyArray<string | number> | undefined

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: ReadonlyArray<number> | undefined

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

readonly

source: Source | undefined

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.