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.

class GraphQLError extends Error {

constructor(message: string, options?: GraphQLErrorOptions);

constructor(

message: string,

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

source?: Maybe<Source>,

positions?: Maybe<ReadonlyArray<number>>,

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

originalError?: Maybe<Error & {

readonly extensions?: unknown;

}>,

extensions?: Maybe<GraphQLErrorExtensions>,

);

readonly extensions: GraphQLErrorExtensions;

readonly locations: ReadonlyArray<SourceLocation> | undefined;

readonly nodes: ReadonlyArray<ASTNode> | undefined;

readonly originalError: Error | undefined;

readonly path: ReadonlyArray<string | number> | undefined;

readonly positions: ReadonlyArray<number> | undefined;

readonly source: Source | undefined;

get [Symbol.toStringTag](): string;

toJSON(): GraphQLFormattedError;

toString(): string;

}

§Extends

Error

[src]

§Constructors

new GraphQLError(message: string, options?: GraphQLErrorOptions)

[src]

new GraphQLError(message: string, nodes?: ReadonlyArray<ASTNode> | ASTNode | null, source?: Maybe<Source>, positions?: Maybe<ReadonlyArray<number>>, path?: Maybe<ReadonlyArray<string | number>>, originalError?: Maybe<Error & {

readonly extensions?: unknown;

}>, extensions?: Maybe<GraphQLErrorExtensions>)

[src]

@deprecated

Please use the GraphQLErrorOptions constructor overload instead.

§Properties

extensions: GraphQLErrorExtensions

[src]

Extension fields to add to the formatted error.

locations: ReadonlyArray<SourceLocation> | undefined

[src]

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

nodes: ReadonlyArray<ASTNode> | undefined

[src]

An array of GraphQL AST Nodes corresponding to this error.

originalError: Error | undefined

[src]

The original error thrown from a field resolver during execution.

path: ReadonlyArray<string | number> | undefined

[src]

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