diff --git a/website/pages/api-v17/error.mdx b/website/pages/api-v17/error.mdx index 1e1bb968b6..689130b992 100644 --- a/website/pages/api-v17/error.mdx +++ b/website/pages/api-v17/error.mdx @@ -70,7 +70,7 @@ Creates a GraphQLError instance. options - Error metadata such as source locations, response path, original error, and extensions. + Error metadata such as source locations, response path, cause, original error, and extensions. @@ -126,7 +126,8 @@ which correspond to this error. originalError - Original error that caused this GraphQLError, if one exists. + Original error that caused this GraphQLError, if one exists.
+Deprecated in favor of {"cause"} to better align with JavaScript standards. extensions @@ -445,7 +446,13 @@ an object which can contain all the values you need. originalError? - Original error that caused this GraphQLError, if one exists. + Original error that caused this GraphQLError, if one exists.
+Deprecated in favor of {"cause"} to better align with JavaScript standards. + + + cause? + + Cause of this GraphQLError, if one exists. extensions? diff --git a/website/pages/api-v17/execution.mdx b/website/pages/api-v17/execution.mdx index 613a823e93..1edabae112 100644 --- a/website/pages/api-v17/execution.mdx +++ b/website/pages/api-v17/execution.mdx @@ -47,21 +47,21 @@ For documentation purposes, these exports are grouped into the following categor

Types:
+ ExecutionArgs + ValidatedExecutionArgs ValidatedSubscriptionArgs + AsyncWorkFinishedInfo + + ExecutionHooks + ExecutionResult FormattedExecutionResult RootSelectionSetExecutor - - ExecutionArgs - - AsyncWorkFinishedInfo - - ExecutionHooks

@@ -1084,6 +1084,98 @@ of calling that function while passing along args and context value. ### Types +#### ExecutionArgs + +**Interface.** Arguments accepted by execute and executeSync. + +
+ +
Members
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescription
schemaThe schema used for validation or execution.
documentThe parsed GraphQL document to execute.
rootValue?Initial root value passed to the operation.
contextValue?Application context value passed to every resolver.
variableValues?Runtime variable values keyed by variable name.
operationName?Name of the operation to execute when the document contains multiple operations.
fieldResolver?Resolver used when a field does not define its own resolver.
typeResolver?Resolver used when an abstract type does not define its own resolver.
subscribeFieldResolver?Resolver used for the root subscription field.
hideSuggestions?Whether suggestion text should be omitted from request errors.
abortSignal?AbortSignal used to cancel execution.
enableEarlyExecution?Whether incremental execution may begin eligible work early.
hooks?Execution hooks invoked during this operation.
options?Additional execution options.
+ +
+ #### ValidatedExecutionArgs **Interface.** Data that must be available at all points during query execution. @@ -1213,39 +1305,37 @@ and the fragments defined in the query document
-#### ExecutionResult +#### AsyncWorkFinishedInfo -**Interface.** Represents the response produced by executing a GraphQL operation. +**Interface.** Information passed to hooks after asynchronous execution work has finished.
-
Type Parameters
+
Members
- - + - - - - - - - - - - + + +
NameConstraintDefaultType Description
TDataShape of the execution data payload.
TExtensionsShape of the extensions payload.validatedExecutionArgsValidated execution arguments for the operation that finished async work.
+
+ +#### ExecutionHooks + +**Interface.** Optional hooks invoked during GraphQL execution. +
Members
@@ -1260,28 +1350,18 @@ and the fragments defined in the query document - errors? - - Errors raised while parsing, validating, or executing the operation. - - - data? - - Data returned by execution, or null when execution could not produce data. - - - extensions? - - Additional non-standard metadata included in the execution result. + asyncWorkFinished? + + Called after all tracked asynchronous execution work has settled.
-#### FormattedExecutionResult +#### ExecutionResult -**Interface.** A JSON-serializable GraphQL execution result. +**Interface.** Represents the response produced by executing a GraphQL operation.
@@ -1301,13 +1381,13 @@ and the fragments defined in the query document TData - Shape of the formatted data payload. + Shape of the execution data payload. TExtensions - Shape of the formatted extensions payload. + Shape of the extensions payload. @@ -1327,7 +1407,7 @@ and the fragments defined in the query document errors? - + Errors raised while parsing, validating, or executing the operation. @@ -1338,117 +1418,46 @@ and the fragments defined in the query document extensions? - Additional non-standard metadata included in the formatted result. + Additional non-standard metadata included in the execution result.
-#### RootSelectionSetExecutor - -**Type alias.** Function used to execute a validated root selection set for a subscription event. - - - -
- -#### ExecutionArgs +#### FormattedExecutionResult -**Interface.** Arguments accepted by execute and executeSync. +**Interface.** A JSON-serializable GraphQL execution result.
-
Members
+
Type Parameters
- + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + - - - + + + +
NameTypeConstraintDefault Description
schemaThe schema used for validation or execution.
documentThe parsed GraphQL document to execute.
rootValue?Initial root value passed to the operation.
contextValue?Application context value passed to every resolver.
variableValues?Runtime variable values keyed by variable name.
operationName?Name of the operation to execute when the document contains multiple operations.
fieldResolver?Resolver used when a field does not define its own resolver.
typeResolver?Resolver used when an abstract type does not define its own resolver.
subscribeFieldResolver?Resolver used for the root subscription field.
hideSuggestions?Whether suggestion text should be omitted from request errors.
abortSignal?AbortSignal used to cancel execution.
enableEarlyExecution?Whether incremental execution may begin eligible work early.
hooks?Execution hooks invoked during this operation.TDataShape of the formatted data payload.
options?Additional execution options.TExtensionsShape of the formatted extensions payload.
-
- -#### AsyncWorkFinishedInfo - -**Interface.** Information passed to hooks after asynchronous execution work has finished. -
Members
@@ -1463,39 +1472,30 @@ and the fragments defined in the query document - validatedExecutionArgs - - Validated execution arguments for the operation that finished async work. + errors? + + Errors raised while parsing, validating, or executing the operation. + + + data? + + Data returned by execution, or null when execution could not produce data. + + + extensions? + + Additional non-standard metadata included in the formatted result.
-#### ExecutionHooks - -**Interface.** Optional hooks invoked during GraphQL execution. - -
+#### RootSelectionSetExecutor -
Members
+**Type alias.** Function used to execute a validated root selection set for a subscription event. - - - - - - - - - - - - - - - -
NameTypeDescription
asyncWorkFinished?Called after all tracked asynchronous execution work has settled.
+ ## Category: Incremental Execution