rename + update docs

Author: cristunaranjo

src/execution/__tests__/executor-test.ts

@@ -1356,7 +1356,7 @@ describe('Execute: Handles basic execution tasks', () => {
       }
     `);
 
-    const executionOptions = {
+    const options = {
       maxCoercionErrors: 1,
     };
 
@@ -1371,13 +1371,11 @@ describe('Execute: Handles basic execution tasks', () => {
           wrongArg3: 'wrong',
         },
       },
-      executionOptions,
+      options,
     });
 
     // Returns at least 2 errors, one for the first 'wrongArg', and one for coercion limit
-    expect(result.errors).to.have.lengthOf(
-      executionOptions.maxCoercionErrors + 1,
-    );
+    expect(result.errors).to.have.lengthOf(options.maxCoercionErrors + 1);
     expect(
       result.errors && result.errors.length > 0
         ? result.errors[result.errors.length - 1].message

src/execution/execute.ts

@@ -152,7 +152,9 @@ export interface ExecutionArgs {
   fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
   typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
   subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
-  executionOptions?: {
+  /** Additional execution options. */
+  options?: {
+    /** Set the maximum number of errors allowed for coercing (defaults to 50). */
     maxCoercionErrors?: number;
   };
 }
@@ -289,7 +291,7 @@ export function buildExecutionContext(
     fieldResolver,
     typeResolver,
     subscribeFieldResolver,
-    executionOptions,
+    options,
   } = args;
 
   let operation: OperationDefinitionNode | undefined;
@@ -333,7 +335,7 @@ export function buildExecutionContext(
     schema,
     variableDefinitions,
     rawVariableValues ?? {},
-    { maxErrors: executionOptions?.maxCoercionErrors ?? 50 },
+    { maxErrors: options?.maxCoercionErrors ?? 50 },
   );
 
   if (coercedVariableValues.errors) {

website/pages/api-v16/execution.mdx

@@ -29,16 +29,20 @@ const { execute } = require('graphql'); // CommonJS
 ### execute
 
 ```ts
-export function execute(
+export function execute({
   schema: GraphQLSchema,
-  documentAST: Document,
-  rootValue?: mixed,
-  contextValue?: mixed,
+  document: DocumentNode,
+  rootValue?: unknown,
+  contextValue?: unknown,
   variableValues?: { [key: string]: mixed },
   operationName?: string,
-): MaybePromise<ExecutionResult>;
+  fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
+  typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
+  subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
+  options?: { maxCoercionErrors?: number };
+}): PromiseOrValue<ExecutionResult>;
 
-type MaybePromise<T> = Promise<T> | T;
+type PromiseOrValue<T> = Promise<T> | T;
 
 interface ExecutionResult<
   TData = ObjMap<unknown>,
@@ -61,21 +65,32 @@ a GraphQLError will be thrown immediately explaining the invalid input.
 executing the query, `errors` is null if no errors occurred, and is a
 non-empty array if an error occurred.
 
+#### options
+
+##### maxCoercionErrors
+
+Set the maximum number of errors allowed for coercing (defaults to 50).
+
 ### executeSync
 
 ```ts
-export function executeSync(
+export function executeSync({
   schema: GraphQLSchema,
-  documentAST: Document,
-  rootValue?: mixed,
-  contextValue?: mixed,
+  document: DocumentNode,
+  rootValue?: unknown,
+  contextValue?: unknown,
   variableValues?: { [key: string]: mixed },
   operationName?: string,
-): ExecutionResult;
+  fieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
+  typeResolver?: Maybe<GraphQLTypeResolver<any, any>>;
+  subscribeFieldResolver?: Maybe<GraphQLFieldResolver<any, any>>;
+  options?: { maxCoercionErrors?: number };
+}): ExecutionResult;
 
 type ExecutionResult = {
-  data: Object;
-  errors?: GraphQLError[];
+  errors?: ReadonlyArray<GraphQLError>;
+  data?: TData | null;
+  extensions?: TExtensions;
 };
 ```