Skip to main content
Latest
interface GraphQLFormattedError
import { type GraphQLFormattedError } from "https://deno.land/x/graphql_deno@v15.0.0/mod.ts";

Type Parameters

optional
TExtensions extends Record<string, any> = Record<string, any>

Properties

readonly
message: string

A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

readonly
optional
locations: ReadonlyArray<SourceLocation>

If an error can be associated to a particular point in the requested GraphQL document, it should contain a list of locations.

readonly
optional
path: ReadonlyArray<string | number>

If an error can be associated to a particular field in the GraphQL result, it must contain an entry with the key path that details the path of the response field which experienced the error. This allows clients to identify whether a null result is intentional or caused by a runtime error.

readonly
optional
extensions: TExtensions

Reserved for implementors to extend the protocol however they see fit, and hence there are no additional restrictions on its contents.