Create, format, and locate GraphQL errors.

These exports are also available from the root graphql package.

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 = {},
);

Members

toString()

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

Signature:

toString(): string;

import { Source } from 'graphql/language';
import { GraphQLError } from 'graphql/error';
 
const error = new GraphQLError('Cannot query field "name".', {
  source: new Source('{ name }'),
  positions: [2],
});
 
error.toString(); // => 'Cannot query field "name".\n\nGraphQL request:1:3\n1 | { name }\n  |   ^'

toJSON()

Returns the JSON representation used when this object is serialized.

Signature:

toJSON(): GraphQLFormattedError;

import { GraphQLError } from 'graphql/error';
 
const error = new GraphQLError('Resolver failed.', {
  path: ['viewer', 'name'],
  extensions: { code: 'INTERNAL' },
});
 
error.toJSON(); // => { message: 'Resolver failed.', path: ['viewer', 'name'], extensions: { code: 'INTERNAL' } }

Functions

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?: Maybe<readonly (string | number)[]>,
): GraphQLError;

import { parse } from 'graphql/language';
import { locatedError } from 'graphql/error';
 
const document = parse('{ viewer { name } }');
const fieldNode = document.definitions[0].selectionSet.selections[0];
const error = locatedError(new Error('Resolver failed'), fieldNode, [
  'viewer',
]);
 
error.message; // => 'Resolver failed'
error.locations; // => [{ line: 1, column: 3 }]
error.path; // => ['viewer']

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;

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'
error.locations; // => [{ line: 1, column: 8 }]

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.

GraphQLFormattedError

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