summaryrefslogtreecommitdiff
path: root/school/node_modules/graphql/error/formatError.d.ts
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2023-01-10 14:54:04 +0100
committerMinteck <contact@minteck.org>2023-01-10 14:54:04 +0100
commit99c1d9af689e5325f3cf535c4007b3aeb8325229 (patch)
treee663b3c2ebdbd67c818ac0c5147f0ce1d2463cda /school/node_modules/graphql/error/formatError.d.ts
parent9871b03912fc28ad38b4037ebf26a78aa937baba (diff)
downloadpluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.tar.gz
pluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.tar.bz2
pluralconnect-99c1d9af689e5325f3cf535c4007b3aeb8325229.zip
Update - This is an automated commit
Diffstat (limited to 'school/node_modules/graphql/error/formatError.d.ts')
-rw-r--r--school/node_modules/graphql/error/formatError.d.ts40
1 files changed, 40 insertions, 0 deletions
diff --git a/school/node_modules/graphql/error/formatError.d.ts b/school/node_modules/graphql/error/formatError.d.ts
new file mode 100644
index 0000000..fb3451b
--- /dev/null
+++ b/school/node_modules/graphql/error/formatError.d.ts
@@ -0,0 +1,40 @@
+import { SourceLocation } from '../language/location';
+
+import { GraphQLError } from './GraphQLError';
+
+/**
+ * Given a GraphQLError, format it according to the rules described by the
+ * Response Format, Errors section of the GraphQL Specification.
+ */
+export function formatError(error: GraphQLError): GraphQLFormattedError;
+
+/**
+ * @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;
+}