Skip to content

Commit

Permalink
Update GraphQLFormattedError (#36205)
Browse files Browse the repository at this point in the history
  • Loading branch information
jedmao authored and rbuckton committed Jun 16, 2019
1 parent d9e739d commit 1e4b5fa
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 5 deletions.
34 changes: 29 additions & 5 deletions types/graphql/error/formatError.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,33 @@ import { SourceLocation } from "../language/location";
*/
export function formatError(error: GraphQLError): GraphQLFormattedError;

export interface GraphQLFormattedError {
readonly message: string;
readonly locations: ReadonlyArray<SourceLocation> | undefined;
readonly path: ReadonlyArray<string | number> | undefined;
readonly extensions?: { [key: string]: any };
/**
* @see https://github.com/graphql/graphql-spec/blob/master/spec/Section%207%20--%20Response.md#errors
*/
export interface GraphQLFormattedError<
TExtensions extends Record<string, any> = Record<string, any>
> {
/**
* 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 message: string
/**
* If an error can be associated to a particular point in the requested
* GraphQL document, it should contain a list of locations.
*/
readonly locations?: ReadonlyArray<SourceLocation>
/**
* 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 path?: ReadonlyArray<string | number>
/**
* Reserved for implementors to extend the protocol however they see fit,
* and hence there are no additional restrictions on its contents.
*/
readonly extensions?: TExtensions
}
1 change: 1 addition & 0 deletions types/graphql/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
// Pavel Lang <https://github.com/langpavel>
// Mark Caudill <https://github.com/mc0>
// Martijn Walraven <https://github.com/martijnwalraven>
// Jed Mao <https://github.com/jedmao>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.6

Expand Down

0 comments on commit 1e4b5fa

Please sign in to comment.