Centralise the definition of GraphQLErrorBehavior

Author: benjie

src/error/ErrorBehavior.ts

@@ -0,0 +1,9 @@
+export type GraphQLErrorBehavior = 'PROPAGATE' | 'NO_PROPAGATE' | 'ABORT';
+
+export function isErrorBehavior(
+  onError: unknown,
+): onError is GraphQLErrorBehavior {
+  return (
+    onError === 'PROPAGATE' || onError === 'NO_PROPAGATE' || onError === 'ABORT'
+  );
+}

src/error/index.ts

@@ -9,3 +9,4 @@ export type {
 export { syntaxError } from './syntaxError';
 
 export { locatedError } from './locatedError';
+export type { GraphQLErrorBehavior } from './ErrorBehavior';

src/execution/execute.ts

@@ -58,6 +58,7 @@ import {
   collectSubfields as _collectSubfields,
 } from './collectFields';
 import { getArgumentValues, getVariableValues } from './values';
+import { GraphQLErrorBehavior, isErrorBehavior } from '../error/ErrorBehavior';
 
 /**
  * A memoized collection of relevant subfields with regard to the return
@@ -116,7 +117,7 @@ export interface ExecutionContext {
   typeResolver: GraphQLTypeResolver<any, any>;
   subscribeFieldResolver: GraphQLFieldResolver<any, any>;
   errors: Array<GraphQLError>;
-  errorBehavior: 'PROPAGATE' | 'NO_PROPAGATE' | 'ABORT';
+  errorBehavior: GraphQLErrorBehavior;
 }
 
 /**
@@ -132,6 +133,7 @@ export interface ExecutionResult<
 > {
   errors?: ReadonlyArray<GraphQLError>;
   data?: TData | null;
+  onError?: GraphQLErrorBehavior;
   extensions?: TExtensions;
 }
 
@@ -162,7 +164,7 @@ export interface ExecutionArgs {
    *
    * @experimental
    */
-  onError?: 'PROPAGATE' | 'NO_PROPAGATE' | 'ABORT';
+  onError?: GraphQLErrorBehavior;
 }
 
 /**
@@ -300,12 +302,7 @@ export function buildExecutionContext(
     onError,
   } = args;
 
-  if (
-    onError != null &&
-    onError !== 'PROPAGATE' &&
-    onError !== 'NO_PROPAGATE' &&
-    onError !== 'ABORT'
-  ) {
+  if (onError != null && !isErrorBehavior(onError)) {
     return [
       new GraphQLError(
         'Unsupported `onError` value; supported values are `PROPAGATE`, `NO_PROPAGATE` and `ABORT`.',

src/graphql.ts

@@ -17,6 +17,7 @@ import { validate } from './validation/validate';
 
 import type { ExecutionResult } from './execution/execute';
 import { execute } from './execution/execute';
+import type { GraphQLErrorBehavior } from './error/ErrorBehavior';
 
 /**
  * This is the primary entry point function for fulfilling GraphQL operations
@@ -74,7 +75,7 @@ export interface GraphQLArgs {
    *
    * @experimental
    */
-  onError?: 'PROPAGATE' | 'NO_PROPAGATE' | 'ABORT';
+  onError?: GraphQLErrorBehavior;
 }
 
 export function graphql(args: GraphQLArgs): Promise<ExecutionResult> {

src/index.ts

@@ -400,6 +400,7 @@ export {
 } from './error/index';
 
 export type {
+  GraphQLErrorBehavior,
   GraphQLErrorOptions,
   GraphQLFormattedError,
   GraphQLErrorExtensions,

src/type/definition.ts

@@ -14,6 +14,7 @@ import type { PromiseOrValue } from '../jsutils/PromiseOrValue';
 import { suggestionList } from '../jsutils/suggestionList';
 import { toObjMap } from '../jsutils/toObjMap';
 
+import type { GraphQLErrorBehavior } from '../error/ErrorBehavior';
 import { GraphQLError } from '../error/GraphQLError';
 
 import type {
@@ -1097,7 +1098,7 @@ export interface GraphQLResolveInfo {
   readonly operation: OperationDefinitionNode;
   readonly variableValues: { [variable: string]: unknown };
   /** @experimental */
-  readonly errorBehavior: 'PROPAGATE' | 'NO_PROPAGATE' | 'ABORT';
+  readonly errorBehavior: GraphQLErrorBehavior;
 }
 
 /**