graphql/error/errors

Classes

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.

Constructor

Creates a GraphQLError instance.

Signature:

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

Arguments

Returns

Constructor

Creates a GraphQLError instance using the legacy positional constructor. Prefer the GraphQLErrorOptions object overload, which keeps optional error metadata in a single options bag.

Signature:

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

Arguments

Returns

Members

toString()

Returns this error as a human-readable message with source locations.

Signature:

toString(): string

Returns

Example

const message = error.toString();
 
// message: the formatted error message

toJSON()

Returns the JSON representation used when this object is serialized.

Signature:

toJSON(): GraphQLFormattedError

Returns

Example

const json = error.toJSON();
 
// json: the JSON representation

Functions

printError()

Prints a GraphQLError to a string, representing useful location information about the error’s position in the source. This helper is retained for backwards compatibility; call error.toString() instead because printError will be removed in v17.

Signature:

printError(error: GraphQLError): string

Arguments

Returns

Example

import { GraphQLError, printError } from 'graphql/error';
 
const message = printError(new GraphQLError('Example error'));
 
// message: 'Example error'

formatError()

Given a GraphQLError, format it according to the rules described by the Response Format, Errors section of the GraphQL Specification. This helper is retained for backwards compatibility; call error.toJSON() instead because formatError will be removed in v17.

Signature:

formatError(error: GraphQLError): GraphQLFormattedError

Arguments

Returns

Example

import { GraphQLError, formatError } from 'graphql/error';
 
const formatted = formatError(new GraphQLError('Example error'));
 
// formatted.message: 'Example error'

locatedError()

Given an arbitrary value, presumably thrown while attempting to execute a GraphQL operation, produce a new GraphQLError aware of the location in the document responsible for the original Error.

Signature:

locatedError(rawOriginalError: unknown, nodes: ASTNode | readonly ASTNode[] | null | undefined, path?: null | undefined | readonly (string | number)[]): GraphQLError

Arguments

Returns

Example

import { locatedError } from 'graphql/error';
 
const error = locatedError(new Error('Resolver failed'));
 
// error.message: 'Resolver failed'

syntaxError()

Produces a GraphQLError representing a syntax error, containing useful descriptive information about the syntax error’s position in the source.

Signature:

syntaxError(source: Source, position: number, description: string): GraphQLError

Arguments

Returns

Example

import { Source } from 'graphql/language';
import { syntaxError } from 'graphql/error';
 
const error = syntaxError(new Source('query {'), 7, 'Expected Name');
 
// error.message: 'Syntax Error: Expected Name'

Types

GraphQLErrorExtensions

Interface. Custom extensions

Remarks: Use a unique identifier name for your extension, for example the name of your library or project. Do not use a shortened identifier as this increases the risk of conflicts. We recommend you add at most one extension field, an object which can contain all the values you need.

GraphQLFormattedErrorExtensions

Interface. Custom formatted extensions

Remarks: Use a unique identifier name for your extension, for example the name of your library or project. Do not use a shortened identifier as this increases the risk of conflicts. We recommend you add at most one extension field, an object which can contain all the values you need.

GraphQLErrorOptions

Interface. Options used to construct a GraphQLError.

Members

GraphQLFormattedError

Interface. See: https://spec.graphql.org/draft/#sec-Errors

Members