mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2026-10-07 00:07:07 +00:00
Update GraphQLFormattedError (#36205)
This commit is contained in:
Vendored
+29
-5
@@ -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
|
||||
}
|
||||
|
||||
Vendored
+1
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user