Skip to content

Commit

Permalink
Add .d.ts comments to flow
Browse files Browse the repository at this point in the history
  • Loading branch information
Jackson Kearl authored and IvanGoncharov committed Aug 22, 2019
1 parent d84cfca commit 37161b2
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions src/error/formatError.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,31 @@ export function formatError(error: GraphQLError): GraphQLFormattedError {
: { message, locations, path };
}

/**
* @see https://github.com/graphql/graphql-spec/blob/master/spec/Section%207%20--%20Response.md#errors
*/
export type GraphQLFormattedError = {|
/**
* A short, human-readable summary of the problem that **SHOULD NOT** change
* from occurrence to occurrence of the problem, except for purposes of
* localization.
*/
+message: string,
/**
* If an error can be associated to a particular point in the requested
* GraphQL document, it should contain a list of locations.
*/
+locations: $ReadOnlyArray<SourceLocation> | void,
/**
* 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.
*/
+path: $ReadOnlyArray<string | number> | void,
/**
* Reserved for implementors to extend the protocol however they see fit,
* and hence there are no additional restrictions on its contents.
*/
+extensions?: { [key: string]: mixed, ... },
|};

0 comments on commit 37161b2

Please sign in to comment.