Ensure ExecutionResult is defined (graphql/graphql.github.io#1049)

graphql · Nov 2, 2024 · cbb7de9 · cbb7de9
1 parent e4c0fe4
commit cbb7de9
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 8 deletions.
diff --git a/website/pages/execution.mdx b/website/pages/execution.mdx
@@ -40,10 +40,14 @@ export function execute(
 
 type MaybePromise<T> = Promise<T> | T;
 
-type ExecutionResult = {
-  data: Object;
-  errors?: GraphQLError[];
-};
+interface ExecutionResult<
+  TData = ObjMap<unknown>,
+  TExtensions = ObjMap<unknown>,
+> {
+  errors?: ReadonlyArray<GraphQLError>;
+  data?: TData | null;
+  extensions?: TExtensions;
+}
 ```
 
 Implements the "Evaluating requests" section of the GraphQL specification.

diff --git a/website/pages/graphql.mdx b/website/pages/graphql.mdx
@@ -144,6 +144,15 @@ function graphql(
   variableValues?: { [key: string]: any },
   operationName?: string,
 ): Promise<GraphQLResult>;
+
+interface ExecutionResult<
+  TData = ObjMap<unknown>,
+  TExtensions = ObjMap<unknown>,
+> {
+  errors?: ReadonlyArray<GraphQLError>;
+  data?: TData | null;
+  extensions?: TExtensions;
+}
 ```
 
 The `graphql` function lexes, parses, validates and executes a GraphQL request.

diff --git a/website/pages/type.mdx b/website/pages/type.mdx
@@ -234,10 +234,6 @@ const OddType = new GraphQLScalarType({
     return null;
   },
 });
-
-function oddValue(value) {
-  return value % 2 === 1 ? value : null;
-}
 ```
 
 ### GraphQLObjectType