@apollo/client 4.2.10 → 4.2.11

package/core/RefetchEventManager.js

@@ -27,7 +27,7 @@ export class RefetchEventManager {
         }
         if (this.client) {
             if (__DEV__) {
-                __DEV__ && invariant.warn(101);
+                __DEV__ && invariant.warn(102);
             }
             this.disconnect();
         }
@@ -96,13 +96,13 @@ export class RefetchEventManager {
         const [payload] = args;
         if (!this.client) {
             if (__DEV__) {
-                __DEV__ && invariant.warn(102, source);
+                __DEV__ && invariant.warn(103, source);
             }
             return;
         }
         if (!this.hasSource(source)) {
             if (__DEV__) {
-                __DEV__ && invariant.warn(103, source);
+                __DEV__ && invariant.warn(104, source);
             }
             return;
         }

package/invariantErrorCodes.js

@@ -444,98 +444,98 @@ const client = new ApolloClient({
     message: "You must provide an `updateQuery` function when using `fetchMore` with a `no-cache` fetch policy."
   },
 
-  89: {
+  90: {
     file: "@apollo/client/core/QueryManager.js",
     message: "QueryManager stopped while query was in flight"
   },
 
-  90: {
+  91: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "this.localState",
     message: "Mutation '%s' contains `@client` fields with variables provided by `@export` but local state has not been configured."
   },
 
-  91: {
+  92: {
     file: "@apollo/client/core/QueryManager.js",
     message: "Store reset while query was in flight (not completed in link chain)"
   },
 
-  94: {
+  95: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "!this.getDocumentInfo(query).hasClientExports || this.localState",
     message: "Subscription '%s' contains `@client` fields with variables provided by `@export` but local state has not been configured."
   },
 
-  95: {
+  96: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "this.localState",
     message: "%s '%s' contains `@client` fields but local state has not been configured."
   },
 
-  96: {
+  97: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "!hasIncrementalDirective",
     message: "%s '%s' contains `@client` and `@defer` directives. These cannot be used together."
   },
 
-  97: {
+  98: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "this.localState",
     message: "Query '%s' contains `@client` fields with variables provided by `@export` but local state has not been configured."
   },
 
-  99: {
+  100: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "this.localState",
     message: "Query '%s' contains `@client` fields but local state has not been configured."
   },
 
-  100: {
+  101: {
     file: "@apollo/client/core/QueryManager.js",
     condition: "didEmitValue",
     message: "The link chain completed without emitting a value. This is likely unintentional and should be updated to emit a value before completing."
   },
 
-  104: {
+  105: {
     file: "@apollo/client/cache/inmemory/entityStore.js",
     condition: "typeof dataId === \"string\"",
     message: "store.merge expects a string ID"
   },
 
-  107: {
+  108: {
     file: "@apollo/client/cache/inmemory/key-extractor.js",
     condition: "extracted !== void 0",
     message: `Missing field '%s' while extracting keyFields from %s`
   },
 
-  108: {
+  109: {
     file: "@apollo/client/cache/inmemory/policies.js",
     condition: "!old || old === which",
     message: `Cannot change root %s __typename more than once`
   },
 
-  111: {
+  112: {
     file: "@apollo/client/cache/inmemory/policies.js",
     message: "Cannot automatically merge arrays"
   },
 
-  112: {
+  113: {
     file: "@apollo/client/cache/inmemory/readFromStore.js",
     message: `No fragment named %s`
   },
 
-  113: {
+  114: {
     file: "@apollo/client/cache/inmemory/readFromStore.js",
     condition: "!isReference(value)",
     message: `Missing selection set for object of type %s returned for query field %s`
   },
 
-  114: {
+  115: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
     message: `Could not identify object %s`
   },
 
-  116: {
+  117: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
     message: `No fragment named %s`
   }
@@ -647,37 +647,56 @@ Did you mean to call refetch(variables) instead of refetch({ variables })?`
     message: "Cannot poll on 'cache-only' query '%s' and as such, polling is disabled. Please use a different fetch policy."
   },
 
-  92: {
+  89: {
+    file: "@apollo/client/core/QueryInfo.js",
+
+    message: `The network result for query %s was written to the cache, but reading it back returned a partial result.
+
+A \`read\` or \`merge\` function left missing fields after this write. Because the cache result is incomplete, Apollo Client cannot apply it to the network result. The raw network result was returned instead, and doesn't include any transformed values returned from \`read\` functions.
+
+To address this problem (which is not a bug in Apollo Client), check the \`read\` and \`merge\` functions for the fields in this query. A \`read\` or \`merge\` function that leaves missing fields leaves the cache unable to fulfill the query's data requirements.
+
+  missing fields: %o
+  network result: %o
+  cache result: %o
+
+For more information, please refer to the documentation:
+
+  * Customizing cache field behavior: https://go.apollo.dev/c/cache-field-behavior
+`
+  },
+
+  93: {
     file: "@apollo/client/core/QueryManager.js",
     message: `Unknown query named "%s" requested in refetchQueries options.include array`
   },
 
-  93: {
+  94: {
     file: "@apollo/client/core/QueryManager.js",
     message: `Unknown anonymous query requested in refetchQueries options.include array`
   },
 
-  98: {
+  99: {
     file: "@apollo/client/core/QueryManager.js",
     message: '[%s]: Fragments masked by data masking are inaccessible when using fetch policy "no-cache". Please add `@unmask` to each fragment spread to access the data.'
   },
 
-  101: {
+  102: {
     file: "@apollo/client/core/RefetchEventManager.js",
     message: "Connected an `ApolloClient` instance to a `RefetchEventManager` that was already connected to a different `ApolloClient`. The previous client has been disconnected and will no longer receive refetch events from this manager."
   },
 
-  102: {
+  103: {
     file: "@apollo/client/core/RefetchEventManager.js",
     message: "Received '%s' event but an `ApolloClient` instance is not connected to the `RefetchEventManager`. No queries will refetch. Pass the manager to the `refetchEventManager` option on the `ApolloClient` constructor."
   },
 
-  103: {
+  104: {
     file: "@apollo/client/core/RefetchEventManager.js",
     message: "Received '%s' event but no source is configured for it on the `RefetchEventManager`. No queries will refetch. Add the event to the `sources` option or call `setEventSource`."
   },
 
-  105: {
+  106: {
     file: "@apollo/client/cache/inmemory/entityStore.js",
 
     message: "cache.modify: You are trying to write a Reference that is not part of the store: %o\n" +
@@ -685,24 +704,24 @@ Did you mean to call refetch(variables) instead of refetch({ variables })?`
         "`toReference(object, true)`"
   },
 
-  106: {
+  107: {
     file: "@apollo/client/cache/inmemory/entityStore.js",
 
     message: "cache.modify: Writing an array with a mix of both References and Objects will not result in the Objects being normalized correctly.\n" +
         "Please convert the object instance %o to a Reference before writing it to the cache by calling `toReference(object, true)`."
   },
 
-  109: {
+  110: {
     file: "@apollo/client/cache/inmemory/policies.js",
     message: `Inferring subtype %s of supertype %s`
   },
 
-  110: {
+  111: {
     file: "@apollo/client/cache/inmemory/policies.js",
     message: `Undefined 'from' passed to readField with arguments %s`
   },
 
-  117: {
+  118: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
 
     message: `Cache data may be lost when replacing the %s field of a %s object.
@@ -721,7 +740,7 @@ For more information about these options, please refer to the documentation:
 `
   },
 
-  118: {
+  119: {
     file: "@apollo/client/cache/core/cache.js",
     message: "Could not identify object passed to `from` for '%s' fragment, either because the object is non-normalized or the key fields are missing. If you are masking this object, please ensure the key fields are requested by the parent object."
   }
@@ -743,7 +762,7 @@ export const devError = {
     message: "Unhandled GraphQL subscription error"
   },
 
-  115: {
+  116: {
     file: "@apollo/client/cache/inmemory/writeToStore.js",
     message: `Missing field '%s' while writing result %o`
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apollo/client",
-  "version": "4.2.10",
+  "version": "4.2.11",
   "description": "A fully-featured caching GraphQL client.",
   "private": false,
   "keywords": [

package/react/hooks/useBackgroundQuery.d.ts

@@ -2,7 +2,7 @@ import type { ApolloClient, DefaultContext, DocumentNode, ErrorPolicy, Operation
 import type { SubscribeToMoreFunction } from "@apollo/client";
 import type { QueryRef } from "@apollo/client/react";
 import type { FetchMoreFunction, RefetchFunction } from "@apollo/client/react/internal";
-import type { DocumentationTypes as UtilityDocumentationTypes, NoInfer, OptionWithFallback, Prettify, SignatureStyle, VariablesOption } from "@apollo/client/utilities/internal";
+import type { NoInfer, OptionWithFallback, Prettify, SignatureStyle, VariablesOption } from "@apollo/client/utilities/internal";
 import type { SkipToken } from "./constants.js";
 export declare namespace useBackgroundQuery {
     import _self = useBackgroundQuery;
@@ -127,7 +127,15 @@ export declare namespace useBackgroundQuery {
     type Options<TVariables extends OperationVariables = OperationVariables> = Base.Options & VariablesOption<TVariables>;
     namespace DocumentationTypes {
         namespace useBackgroundQuery {
-            interface Options<TVariables extends OperationVariables = OperationVariables> extends Omit<Base.Options, "variables">, UtilityDocumentationTypes.VariableOptions<TVariables> {
+            interface Options<TVariables extends OperationVariables = OperationVariables> extends Base.Options {
+                /**
+                * An object containing all of the GraphQL variables your query requires to execute.
+                * 
+                * Each key in the object corresponds to a variable name, and that key's value corresponds to the variable value.
+                * 
+                * @docGroup 1. Operation options
+                */
+                variables?: TVariables;
             }
         }
     }

package/react/hooks/useBackgroundQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"useBackgroundQuery.js","sourceRoot":"","sources":["../../../src/react/hooks/useBackgroundQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAqB/B,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,YAAY,GACb,MAAM,+BAA+B,CAAC;AAWvC,OAAO,EAAE,uBAAuB,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAwzB7D,MAAM,CAAC,MAAM,kBAAkB,GAC7B,SAAS,kBAAkB,CAIzB,KAA0D,EAC1D,OAAqE;IAKrE,aAAa,CAAC;IACd,OAAO,QAAQ,CACb,oBAAoB,EACpB,mBAAmB,EACnB,eAAe,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAC1E,CAAC,KAAK,EAAE,OAAO,IAAK,EAAU,CAAC,CAAC;AACnC,CAAQ,CAAC;AAEX,SAAS,mBAAmB,CAK1B,KAA0D,EAC1D,OAEmD;IAKnD,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3E,MAAM,EAAE,WAAW,EAAE,GAAG,iBAAiB,CAAC;IAC1C,MAAM,QAAQ,GAAG,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAEzD,yEAAyE;IACzE,iEAAiE;IACjE,wEAAwE;IACxE,wEAAwE;IACxE,6EAA6E;IAC7E,uBAAuB;IACvB,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC;IAC/D,cAAc,CAAC,OAAO,KAAK,WAAW,KAAK,SAAS,CAAC;IAErD,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,CAAiB,QAAQ,EAAE,GAAG,EAAE,CACxE,MAAM,CAAC,UAAU,CACf,iBAA6D,CAC9D,CACF,CAAC;IAEF,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAC1D,YAAY,CAAC,QAAQ,CAAC,CACvB,CAAC;IACF,IAAI,cAAc,CAAC,eAAe,CAAC,KAAK,QAAQ,EAAE,CAAC;QACjD,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,QAAQ,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QACzD,qBAAqB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,sEAAsE;IACtE,2EAA2E;IAC3E,0EAA0E;IAC1E,6EAA6E;IAC7E,yDAAyD;IACzD,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,2EAA2E;QAC3E,iEAAiE;QACjE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE;YACzB,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACtB,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACxC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAC9B,uEAAuE;QACvE,kEAAkE;IACpE,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CACjC,CACE,OAAsE,EACtE,EAAE;QACF,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE5C,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE3C,OAAO,OAAO,CAAC;IACjB,CAAC,EACD,CAAC,QAAQ,CAAC,CAC6B,CAAC;IAE1C,MAAM,OAAO,GAAuC,KAAK,CAAC,WAAW,CACnE,CAAC,SAAS,EAAE,EAAE;QACZ,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAE5C,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE3C,OAAO,OAAO,CAAC;IACjB,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEzD,OAAO;QACL,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC;QACjD;YACE,SAAS;YACT,OAAO;YACP,kGAAkG;YAClG,eAAe,EAAE,QAAQ,CAAC,UAAU;iBACjC,eAA6D;SACjE;KACF,CAAC;AACJ,CAAC","sourcesContent":["import * as React from \"react\";\n\nimport type {\n  ApolloClient,\n  DataState,\n  DefaultContext,\n  DocumentNode,\n  ErrorPolicy,\n  ObservableQuery,\n  OperationVariables,\n  RefetchOn,\n  RefetchWritePolicy,\n  TypedDocumentNode,\n  WatchQueryFetchPolicy,\n} from \"@apollo/client\";\nimport type { SubscribeToMoreFunction } from \"@apollo/client\";\nimport type { QueryRef } from \"@apollo/client/react\";\nimport type {\n  FetchMoreFunction,\n  RefetchFunction,\n} from \"@apollo/client/react/internal\";\nimport {\n  getSuspenseCache,\n  unwrapQueryRef,\n  updateWrappedQueryRef,\n  wrapQueryRef,\n} from \"@apollo/client/react/internal\";\nimport type {\n  DocumentationTypes as UtilityDocumentationTypes,\n  NoInfer,\n  OptionWithFallback,\n  Prettify,\n  SignatureStyle,\n  VariablesOption,\n} from \"@apollo/client/utilities/internal\";\n\nimport type { SkipToken } from \"./constants.js\";\nimport { useSuspenseHookCacheKey, wrapHook } from \"./internal/index.js\";\nimport { useApolloClient } from \"./useApolloClient.js\";\nimport { useWatchQueryOptions } from \"./useSuspenseQuery.js\";\n\nexport declare namespace useBackgroundQuery {\n  import _self = useBackgroundQuery;\n  export type FetchPolicy = Extract<\n    WatchQueryFetchPolicy,\n    \"cache-first\" | \"network-only\" | \"no-cache\" | \"cache-and-network\"\n  >;\n\n  export namespace Base {\n    export interface Options {\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#client:member} */\n      client?: ApolloClient;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#refetchWritePolicy_suspense:member} */\n      refetchWritePolicy?: RefetchWritePolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#errorPolicy:member} */\n      errorPolicy?: ErrorPolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#context:member} */\n      context?: DefaultContext;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#returnPartialData:member} */\n      returnPartialData?: boolean;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#fetchPolicy:member} */\n      fetchPolicy?: FetchPolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#queryKey:member} */\n      queryKey?: string | number | any[];\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#refetchOn:member} */\n      refetchOn?: RefetchOn.Option;\n\n      /**\n       * {@inheritDoc @apollo/client!QueryOptionsDocumentation#skip_deprecated:member}\n       *\n       * @example Recommended usage of `skipToken`:\n       *\n       * ```ts\n       * import { skipToken, useBackgroundQuery } from \"@apollo/client\";\n       *\n       * const [queryRef] = useBackgroundQuery(\n       *   query,\n       *   id ? { variables: { id } } : skipToken\n       * );\n       * ```\n       */\n      skip?: boolean;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#variables:member} */\n      variables?: unknown;\n    }\n  }\n\n  export type Options<\n    TVariables extends OperationVariables = OperationVariables,\n  > = Base.Options & VariablesOption<TVariables>;\n\n  export namespace DocumentationTypes {\n    namespace useBackgroundQuery {\n      export interface Options<\n        TVariables extends OperationVariables = OperationVariables,\n      > extends Omit<Base.Options, \"variables\">,\n          UtilityDocumentationTypes.VariableOptions<TVariables> {}\n    }\n  }\n\n  export interface Result<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n    TErrorPolicy extends ErrorPolicy | undefined = undefined,\n  > {\n    /** {@inheritDoc @apollo/client!ObservableQuery#subscribeToMore:member(1)} */\n    subscribeToMore: SubscribeToMoreFunction<TData, TVariables>;\n\n    /**\n     * {@inheritDoc @apollo/client!ObservableQuery#fetchMore:member(1)}\n     *\n     * @remarks\n     * Calling this function will cause the component to re-suspend, unless the call site is wrapped in [`startTransition`](https://react.dev/reference/react/startTransition).\n     */\n    fetchMore: FetchMoreFunction<TData, TVariables>;\n\n    /**\n     * {@inheritDoc @apollo/client!QueryResultDocumentation#refetch:member}\n     *\n     * @remarks\n     * Calling this function will cause the component to re-suspend, unless the call site is wrapped in [`startTransition`](https://react.dev/reference/react/startTransition).\n     */\n    refetch: RefetchFunction<TData, TVariables, TErrorPolicy>;\n  }\n\n  namespace DocumentationTypes {\n    namespace useBackgroundQuery {\n      export interface Result<\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      > extends _self.Result<TData, TVariables> {}\n    }\n  }\n\n  export interface DefaultOptions\n    extends ApolloClient.DefaultOptions.WatchQuery.Calculated {\n    skip: false;\n  }\n\n  export type OptionsFor<\n    TVariables extends OperationVariables,\n    TOptions extends { variables?: unknown },\n  > = useBackgroundQuery.Options<NoInfer<TVariables>> & {\n    variables?: Prettify<\n      TVariables & {\n        // variables that are not part of `TVariables`\n        [K in keyof TOptions[\"variables\"]]: K extends keyof TVariables ?\n          TVariables[K]\n        : never;\n      }\n    >;\n  } & (Exclude<\n      keyof Exclude<TOptions, SkipToken>,\n      keyof useBackgroundQuery.Options<any>\n    > extends infer InvalidOptionNames extends string ?\n      [InvalidOptionNames] extends [never] ?\n        unknown\n      : { [K in InvalidOptionNames]: never }\n    : never);\n\n  export type ResultForOptions<\n    TData,\n    TVariables extends OperationVariables,\n    TOptions extends Record<string, never> | Base.Options | SkipToken,\n  > = [\n    queryRef: TOptions extends any ?\n      TOptions extends SkipToken ?\n        undefined\n      : | QueryRef<\n            TData,\n            TVariables,\n            | \"complete\"\n            | \"streaming\"\n            | (\n                | (OptionWithFallback<\n                    TOptions,\n                    DefaultOptions,\n                    \"errorPolicy\"\n                  > extends \"none\" ?\n                    never\n                  : \"empty\")\n                | (OptionWithFallback<\n                    TOptions,\n                    DefaultOptions,\n                    \"returnPartialData\"\n                  > extends false ?\n                    never\n                  : \"partial\")\n              )\n          >\n        | (OptionWithFallback<TOptions, DefaultOptions, \"skip\"> extends false ?\n            never\n          : undefined)\n    : never,\n    result: useBackgroundQuery.Result<\n      TData,\n      TVariables,\n      OptionWithFallback<TOptions, DefaultOptions, \"errorPolicy\"> & ErrorPolicy\n    >,\n  ];\n\n  export namespace DocumentationTypes {\n    export interface useBackgroundQuery {\n      /**\n       * For a detailed explanation of useBackgroundQuery, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).\n       *\n       * @returns A tuple containing:\n       *\n       * 1.  A `QueryRef` that can be passed to `useReadQuery` to read the query result. The `queryRef` is `undefined` if the query is skipped.\n       * 2.  An object containing helper functions for the query:\n       *     - `refetch`: A function to re-execute the query\n       *     - `fetchMore`: A function to fetch more results for pagination\n       *     - `subscribeToMore`: A function to subscribe to updates\n       *\n       * @example\n       *\n       * ```jsx\n       * import { Suspense } from \"react\";\n       * import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\";\n       * import { useBackgroundQuery, useReadQuery } from \"@apollo/client/react\";\n       *\n       * const query = gql`\n       *   foo {\n       *     bar\n       *   }\n       * `;\n       *\n       * const client = new ApolloClient({\n       *   link: new HttpLink({ uri: \"http://localhost:4000/graphql\" }),\n       *   cache: new InMemoryCache(),\n       * });\n       *\n       * function SuspenseFallback() {\n       *   return <div>Loading...</div>;\n       * }\n       *\n       * function Child({ queryRef }) {\n       *   const { data } = useReadQuery(queryRef);\n       *\n       *   return <div>{data.foo.bar}</div>;\n       * }\n       *\n       * function Parent() {\n       *   const [queryRef] = useBackgroundQuery(query);\n       *\n       *   return (\n       *     <Suspense fallback={<SuspenseFallback />}>\n       *       <Child queryRef={queryRef} />\n       *     </Suspense>\n       *   );\n       * }\n       *\n       * function App() {\n       *   return (\n       *     <ApolloProvider client={client}>\n       *       <Parent />\n       *     </ApolloProvider>\n       *   );\n       * }\n       * ```\n       *\n       * @param query - A GraphQL query document parsed into an AST by `gql`.\n       * @param options - An optional object containing options for the query. Instead of passing a `useBackgroundQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useBackgroundQuery` hook from executing the query or suspending.\n       */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<TVariables>\n      ): [\n        QueryRef<TData, TVariables> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n\n    export interface useBackgroundQuery_Deprecated {\n      /**\n       * @deprecated Avoid manually specifying generics on `useBackgroundQuery`.\n       * Instead, rely on TypeScript's type inference along with a correctly typed `TypedDocumentNode` to get accurate types for your query results.\n       *\n       * {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)}\n       */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<TVariables>\n      ): [\n        QueryRef<TData, TVariables> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n  }\n\n  export namespace Signatures {\n    /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n    export interface Classic {\n      // _INFERENCE_ONLY_DO_NOT_SPECIFY is used to distinguish between inferred\n      // generics arguments and explicit generic arguments so that we can\n      // provide a `@deprecated` signature for explicit generic arguments. As\n      // soon as a user provides a generic arg (e.g. useBackgroundQuery<TData>(query))`,\n      // the overload falls through to the overloads without\n      // _INFERENCE_ONLY_DO_NOT_SPECIFY.\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          /** @deprecated `returnPartialData` has no effect on `no-cache` queries */\n          returnPartialData: boolean;\n          fetchPolicy: \"no-cache\";\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n          errorPolicy: TErrorPolicy & (\"ignore\" | \"all\");\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n          errorPolicy: TErrorPolicy & (\"ignore\" | \"all\");\n        }\n      ): [\n        QueryRef<\n          TData,\n          TVariables,\n          \"complete\" | \"streaming\" | \"partial\" | \"empty\"\n        >,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          errorPolicy: TErrorPolicy & (\"ignore\" | \"all\");\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: false;\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: boolean;\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken\n      ): [undefined, useBackgroundQuery.Result<TData, TVariables>];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: false;\n              errorPolicy?: TErrorPolicy;\n            })\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: boolean;\n              errorPolicy?: TErrorPolicy;\n            })\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              errorPolicy?: TErrorPolicy;\n            },\n          ]\n        : [\n            options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              errorPolicy?: TErrorPolicy;\n            },\n          ]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?:\n              | SkipToken\n              | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n                  errorPolicy?: TErrorPolicy;\n                }),\n          ]\n        : [\n            options:\n              | SkipToken\n              | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n                  errorPolicy?: TErrorPolicy;\n                }),\n          ]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              errorPolicy?: TErrorPolicy;\n            })\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          /** @deprecated `returnPartialData` has no effect on `no-cache` queries */\n          returnPartialData: boolean;\n          fetchPolicy: \"no-cache\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<\n          TData,\n          TVariables,\n          \"complete\" | \"streaming\" | \"partial\" | \"empty\"\n        >,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: false;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: boolean;\n        }\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken\n      ): [undefined, useBackgroundQuery.Result<TData, TVariables>];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: false;\n            })\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: boolean;\n            })\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [options?: useBackgroundQuery.Options<NoInfer<TVariables>>]\n        : [options: useBackgroundQuery.Options<NoInfer<TVariables>>]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?:\n              | SkipToken\n              | useBackgroundQuery.Options<NoInfer<TVariables>>,\n          ]\n        : [options: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n\n    /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n    export interface Modern {\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends never,\n      >(\n        query: {} extends TVariables ?\n          DocumentNode | TypedDocumentNode<TData, TVariables>\n        : // this overload should only be accessible if all `TVariables` are optional\n          never\n      ): useBackgroundQuery.ResultForOptions<\n        TData,\n        TVariables,\n        Record<string, never>\n      >;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends Base.Options,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?: TOptions &\n              useBackgroundQuery.OptionsFor<TVariables, TOptions>,\n          ]\n        : [\n            options: TOptions &\n              useBackgroundQuery.OptionsFor<TVariables, TOptions>,\n          ]\n      ): useBackgroundQuery.ResultForOptions<TData, TVariables, TOptions>;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends never,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        skipToken: SkipToken\n      ): useBackgroundQuery.ResultForOptions<TData, TVariables, SkipToken>;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends Base.Options,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?:\n              | (TOptions & useBackgroundQuery.OptionsFor<TVariables, TOptions>)\n              | SkipToken,\n          ]\n        : [\n            options:\n              | (TOptions & useBackgroundQuery.OptionsFor<TVariables, TOptions>)\n              | SkipToken,\n          ]\n      ): useBackgroundQuery.ResultForOptions<\n        TData,\n        TVariables,\n        TOptions | SkipToken\n      >;\n    }\n\n    export type Evaluated = SignatureStyle extends \"classic\" ? Classic : Modern;\n  }\n\n  /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n  export interface Signature extends Signatures.Evaluated {}\n}\n\nexport const useBackgroundQuery: useBackgroundQuery.Signature =\n  function useBackgroundQuery<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n  >(\n    query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n    options?: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>\n  ): [\n    QueryRef<TData, TVariables, DataState<TData>[\"dataState\"]> | undefined,\n    useBackgroundQuery.Result<TData, TVariables>,\n  ] {\n    \"use no memo\";\n    return wrapHook(\n      \"useBackgroundQuery\",\n      useBackgroundQuery_,\n      useApolloClient(typeof options === \"object\" ? options.client : undefined)\n    )(query, options ?? ({} as any));\n  } as any;\n\nfunction useBackgroundQuery_<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n  TStates extends DataState<TData>[\"dataState\"] = DataState<TData>[\"dataState\"],\n>(\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n  options:\n    | (SkipToken & Partial<useBackgroundQuery.Options<NoInfer<TVariables>>>)\n    | useBackgroundQuery.Options<NoInfer<TVariables>>\n): [\n  QueryRef<TData, TVariables, TStates> | undefined,\n  useBackgroundQuery.Result<TData, TVariables>,\n] {\n  const client = useApolloClient(options.client);\n  const suspenseCache = getSuspenseCache(client);\n  const watchQueryOptions = useWatchQueryOptions({ client, query, options });\n  const { fetchPolicy } = watchQueryOptions;\n  const cacheKey = useSuspenseHookCacheKey(query, options);\n\n  // This ref tracks the first time query execution is enabled to determine\n  // whether to return a query ref or `undefined`. When initialized\n  // in a skipped state (either via `skip: true` or `skipToken`) we return\n  // `undefined` for the `queryRef` until the query has been enabled. Once\n  // enabled, a query ref is always returned regardless of whether the query is\n  // skipped again later.\n  const didFetchResult = React.useRef(fetchPolicy !== \"standby\");\n  didFetchResult.current ||= fetchPolicy !== \"standby\";\n\n  const queryRef = suspenseCache.getQueryRef<TData, TStates>(cacheKey, () =>\n    client.watchQuery(\n      watchQueryOptions as ApolloClient.WatchQueryOptions<any, any>\n    )\n  );\n\n  const [wrappedQueryRef, setWrappedQueryRef] = React.useState(\n    wrapQueryRef(queryRef)\n  );\n  if (unwrapQueryRef(wrappedQueryRef) !== queryRef) {\n    setWrappedQueryRef(wrapQueryRef(queryRef));\n  }\n  if (queryRef.didChangeOptions(watchQueryOptions)) {\n    const promise = queryRef.applyOptions(watchQueryOptions);\n    updateWrappedQueryRef(wrappedQueryRef, promise);\n  }\n\n  // This prevents issues where rerendering useBackgroundQuery after the\n  // queryRef has been disposed would cause the hook to return a new queryRef\n  // instance since disposal also removes it from the suspense cache. We add\n  // the queryRef back in the suspense cache so that the next render will reuse\n  // this queryRef rather than initializing a new instance.\n  React.useEffect(() => {\n    // Since the queryRef is disposed async via `setTimeout`, we have to wait a\n    // tick before checking it and adding back to the suspense cache.\n    const id = setTimeout(() => {\n      if (queryRef.disposed) {\n        suspenseCache.add(cacheKey, queryRef);\n      }\n    });\n\n    return () => clearTimeout(id);\n    // Omitting the deps is intentional. This avoids stale closures and the\n    // conditional ensures we aren't running the logic on each render.\n  });\n\n  const fetchMore = React.useCallback(\n    (\n      options: ObservableQuery.FetchMoreOptions<TData, TVariables, any, any>\n    ) => {\n      const promise = queryRef.fetchMore(options);\n\n      setWrappedQueryRef(wrapQueryRef(queryRef));\n\n      return promise;\n    },\n    [queryRef]\n  ) as FetchMoreFunction<TData, TVariables>;\n\n  const refetch: RefetchFunction<TData, TVariables> = React.useCallback(\n    (variables) => {\n      const promise = queryRef.refetch(variables);\n\n      setWrappedQueryRef(wrapQueryRef(queryRef));\n\n      return promise;\n    },\n    [queryRef]\n  );\n\n  React.useEffect(() => queryRef.softRetain(), [queryRef]);\n\n  return [\n    didFetchResult.current ? wrappedQueryRef : void 0,\n    {\n      fetchMore,\n      refetch,\n      // TODO: The internalQueryRef doesn't have TVariables' type information so we have to cast it here\n      subscribeToMore: queryRef.observable\n        .subscribeToMore as SubscribeToMoreFunction<TData, TVariables>,\n    },\n  ];\n}\n"]}
+{"version":3,"file":"useBackgroundQuery.js","sourceRoot":"","sources":["../../../src/react/hooks/useBackgroundQuery.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAqB/B,OAAO,EACL,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,YAAY,GACb,MAAM,+BAA+B,CAAC;AAUvC,OAAO,EAAE,uBAAuB,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AA0zB7D,MAAM,CAAC,MAAM,kBAAkB,GAC7B,SAAS,kBAAkB,CAIzB,KAA0D,EAC1D,OAAqE;IAKrE,aAAa,CAAC;IACd,OAAO,QAAQ,CACb,oBAAoB,EACpB,mBAAmB,EACnB,eAAe,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAC1E,CAAC,KAAK,EAAE,OAAO,IAAK,EAAU,CAAC,CAAC;AACnC,CAAQ,CAAC;AAEX,SAAS,mBAAmB,CAK1B,KAA0D,EAC1D,OAEmD;IAKnD,MAAM,MAAM,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,aAAa,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;IAC/C,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IAC3E,MAAM,EAAE,WAAW,EAAE,GAAG,iBAAiB,CAAC;IAC1C,MAAM,QAAQ,GAAG,uBAAuB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAEzD,yEAAyE;IACzE,iEAAiE;IACjE,wEAAwE;IACxE,wEAAwE;IACxE,6EAA6E;IAC7E,uBAAuB;IACvB,MAAM,cAAc,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC;IAC/D,cAAc,CAAC,OAAO,KAAK,WAAW,KAAK,SAAS,CAAC;IAErD,MAAM,QAAQ,GAAG,aAAa,CAAC,WAAW,CAAiB,QAAQ,EAAE,GAAG,EAAE,CACxE,MAAM,CAAC,UAAU,CACf,iBAA6D,CAC9D,CACF,CAAC;IAEF,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,KAAK,CAAC,QAAQ,CAC1D,YAAY,CAAC,QAAQ,CAAC,CACvB,CAAC;IACF,IAAI,cAAc,CAAC,eAAe,CAAC,KAAK,QAAQ,EAAE,CAAC;QACjD,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC7C,CAAC;IACD,IAAI,QAAQ,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,EAAE,CAAC;QACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC;QACzD,qBAAqB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IAClD,CAAC;IAED,sEAAsE;IACtE,2EAA2E;IAC3E,0EAA0E;IAC1E,6EAA6E;IAC7E,yDAAyD;IACzD,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,2EAA2E;QAC3E,iEAAiE;QACjE,MAAM,EAAE,GAAG,UAAU,CAAC,GAAG,EAAE;YACzB,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACtB,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YACxC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,GAAG,EAAE,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;QAC9B,uEAAuE;QACvE,kEAAkE;IACpE,CAAC,CAAC,CAAC;IAEH,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CACjC,CACE,OAAsE,EACtE,EAAE;QACF,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAE5C,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE3C,OAAO,OAAO,CAAC;IACjB,CAAC,EACD,CAAC,QAAQ,CAAC,CAC6B,CAAC;IAE1C,MAAM,OAAO,GAAuC,KAAK,CAAC,WAAW,CACnE,CAAC,SAAS,EAAE,EAAE;QACZ,MAAM,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;QAE5C,kBAAkB,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC;QAE3C,OAAO,OAAO,CAAC;IACjB,CAAC,EACD,CAAC,QAAQ,CAAC,CACX,CAAC;IAEF,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,UAAU,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC;IAEzD,OAAO;QACL,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,KAAK,CAAC;QACjD;YACE,SAAS;YACT,OAAO;YACP,kGAAkG;YAClG,eAAe,EAAE,QAAQ,CAAC,UAAU;iBACjC,eAA6D;SACjE;KACF,CAAC;AACJ,CAAC","sourcesContent":["import * as React from \"react\";\n\nimport type {\n  ApolloClient,\n  DataState,\n  DefaultContext,\n  DocumentNode,\n  ErrorPolicy,\n  ObservableQuery,\n  OperationVariables,\n  RefetchOn,\n  RefetchWritePolicy,\n  TypedDocumentNode,\n  WatchQueryFetchPolicy,\n} from \"@apollo/client\";\nimport type { SubscribeToMoreFunction } from \"@apollo/client\";\nimport type { QueryRef } from \"@apollo/client/react\";\nimport type {\n  FetchMoreFunction,\n  RefetchFunction,\n} from \"@apollo/client/react/internal\";\nimport {\n  getSuspenseCache,\n  unwrapQueryRef,\n  updateWrappedQueryRef,\n  wrapQueryRef,\n} from \"@apollo/client/react/internal\";\nimport type {\n  NoInfer,\n  OptionWithFallback,\n  Prettify,\n  SignatureStyle,\n  VariablesOption,\n} from \"@apollo/client/utilities/internal\";\n\nimport type { SkipToken } from \"./constants.js\";\nimport { useSuspenseHookCacheKey, wrapHook } from \"./internal/index.js\";\nimport { useApolloClient } from \"./useApolloClient.js\";\nimport { useWatchQueryOptions } from \"./useSuspenseQuery.js\";\n\nexport declare namespace useBackgroundQuery {\n  import _self = useBackgroundQuery;\n  export type FetchPolicy = Extract<\n    WatchQueryFetchPolicy,\n    \"cache-first\" | \"network-only\" | \"no-cache\" | \"cache-and-network\"\n  >;\n\n  export namespace Base {\n    export interface Options {\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#client:member} */\n      client?: ApolloClient;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#refetchWritePolicy_suspense:member} */\n      refetchWritePolicy?: RefetchWritePolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#errorPolicy:member} */\n      errorPolicy?: ErrorPolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#context:member} */\n      context?: DefaultContext;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#returnPartialData:member} */\n      returnPartialData?: boolean;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#fetchPolicy:member} */\n      fetchPolicy?: FetchPolicy;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#queryKey:member} */\n      queryKey?: string | number | any[];\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#refetchOn:member} */\n      refetchOn?: RefetchOn.Option;\n\n      /**\n       * {@inheritDoc @apollo/client!QueryOptionsDocumentation#skip_deprecated:member}\n       *\n       * @example Recommended usage of `skipToken`:\n       *\n       * ```ts\n       * import { skipToken, useBackgroundQuery } from \"@apollo/client\";\n       *\n       * const [queryRef] = useBackgroundQuery(\n       *   query,\n       *   id ? { variables: { id } } : skipToken\n       * );\n       * ```\n       */\n      skip?: boolean;\n\n      /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#variables:member} */\n      variables?: unknown;\n    }\n  }\n\n  export type Options<\n    TVariables extends OperationVariables = OperationVariables,\n  > = Base.Options & VariablesOption<TVariables>;\n\n  export namespace DocumentationTypes {\n    namespace useBackgroundQuery {\n      export interface Options<\n        TVariables extends OperationVariables = OperationVariables,\n      > extends Base.Options {\n        /** {@inheritDoc @apollo/client!QueryOptionsDocumentation#variables:member} */\n        variables?: TVariables;\n      }\n    }\n  }\n\n  export interface Result<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n    TErrorPolicy extends ErrorPolicy | undefined = undefined,\n  > {\n    /** {@inheritDoc @apollo/client!ObservableQuery#subscribeToMore:member(1)} */\n    subscribeToMore: SubscribeToMoreFunction<TData, TVariables>;\n\n    /**\n     * {@inheritDoc @apollo/client!ObservableQuery#fetchMore:member(1)}\n     *\n     * @remarks\n     * Calling this function will cause the component to re-suspend, unless the call site is wrapped in [`startTransition`](https://react.dev/reference/react/startTransition).\n     */\n    fetchMore: FetchMoreFunction<TData, TVariables>;\n\n    /**\n     * {@inheritDoc @apollo/client!QueryResultDocumentation#refetch:member}\n     *\n     * @remarks\n     * Calling this function will cause the component to re-suspend, unless the call site is wrapped in [`startTransition`](https://react.dev/reference/react/startTransition).\n     */\n    refetch: RefetchFunction<TData, TVariables, TErrorPolicy>;\n  }\n\n  namespace DocumentationTypes {\n    namespace useBackgroundQuery {\n      export interface Result<\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      > extends _self.Result<TData, TVariables> {}\n    }\n  }\n\n  export interface DefaultOptions\n    extends ApolloClient.DefaultOptions.WatchQuery.Calculated {\n    skip: false;\n  }\n\n  export type OptionsFor<\n    TVariables extends OperationVariables,\n    TOptions extends { variables?: unknown },\n  > = useBackgroundQuery.Options<NoInfer<TVariables>> & {\n    variables?: Prettify<\n      TVariables & {\n        // variables that are not part of `TVariables`\n        [K in keyof TOptions[\"variables\"]]: K extends keyof TVariables ?\n          TVariables[K]\n        : never;\n      }\n    >;\n  } & (Exclude<\n      keyof Exclude<TOptions, SkipToken>,\n      keyof useBackgroundQuery.Options<any>\n    > extends infer InvalidOptionNames extends string ?\n      [InvalidOptionNames] extends [never] ?\n        unknown\n      : { [K in InvalidOptionNames]: never }\n    : never);\n\n  export type ResultForOptions<\n    TData,\n    TVariables extends OperationVariables,\n    TOptions extends Record<string, never> | Base.Options | SkipToken,\n  > = [\n    queryRef: TOptions extends any ?\n      TOptions extends SkipToken ?\n        undefined\n      : | QueryRef<\n            TData,\n            TVariables,\n            | \"complete\"\n            | \"streaming\"\n            | (\n                | (OptionWithFallback<\n                    TOptions,\n                    DefaultOptions,\n                    \"errorPolicy\"\n                  > extends \"none\" ?\n                    never\n                  : \"empty\")\n                | (OptionWithFallback<\n                    TOptions,\n                    DefaultOptions,\n                    \"returnPartialData\"\n                  > extends false ?\n                    never\n                  : \"partial\")\n              )\n          >\n        | (OptionWithFallback<TOptions, DefaultOptions, \"skip\"> extends false ?\n            never\n          : undefined)\n    : never,\n    result: useBackgroundQuery.Result<\n      TData,\n      TVariables,\n      OptionWithFallback<TOptions, DefaultOptions, \"errorPolicy\"> & ErrorPolicy\n    >,\n  ];\n\n  export namespace DocumentationTypes {\n    export interface useBackgroundQuery {\n      /**\n       * For a detailed explanation of useBackgroundQuery, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).\n       *\n       * @returns A tuple containing:\n       *\n       * 1.  A `QueryRef` that can be passed to `useReadQuery` to read the query result. The `queryRef` is `undefined` if the query is skipped.\n       * 2.  An object containing helper functions for the query:\n       *     - `refetch`: A function to re-execute the query\n       *     - `fetchMore`: A function to fetch more results for pagination\n       *     - `subscribeToMore`: A function to subscribe to updates\n       *\n       * @example\n       *\n       * ```jsx\n       * import { Suspense } from \"react\";\n       * import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\";\n       * import { useBackgroundQuery, useReadQuery } from \"@apollo/client/react\";\n       *\n       * const query = gql`\n       *   foo {\n       *     bar\n       *   }\n       * `;\n       *\n       * const client = new ApolloClient({\n       *   link: new HttpLink({ uri: \"http://localhost:4000/graphql\" }),\n       *   cache: new InMemoryCache(),\n       * });\n       *\n       * function SuspenseFallback() {\n       *   return <div>Loading...</div>;\n       * }\n       *\n       * function Child({ queryRef }) {\n       *   const { data } = useReadQuery(queryRef);\n       *\n       *   return <div>{data.foo.bar}</div>;\n       * }\n       *\n       * function Parent() {\n       *   const [queryRef] = useBackgroundQuery(query);\n       *\n       *   return (\n       *     <Suspense fallback={<SuspenseFallback />}>\n       *       <Child queryRef={queryRef} />\n       *     </Suspense>\n       *   );\n       * }\n       *\n       * function App() {\n       *   return (\n       *     <ApolloProvider client={client}>\n       *       <Parent />\n       *     </ApolloProvider>\n       *   );\n       * }\n       * ```\n       *\n       * @param query - A GraphQL query document parsed into an AST by `gql`.\n       * @param options - An optional object containing options for the query. Instead of passing a `useBackgroundQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useBackgroundQuery` hook from executing the query or suspending.\n       */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<TVariables>\n      ): [\n        QueryRef<TData, TVariables> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n\n    export interface useBackgroundQuery_Deprecated {\n      /**\n       * @deprecated Avoid manually specifying generics on `useBackgroundQuery`.\n       * Instead, rely on TypeScript's type inference along with a correctly typed `TypedDocumentNode` to get accurate types for your query results.\n       *\n       * {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)}\n       */\n      <\n        TData = unknown,\n        TVariables extends OperationVariables = OperationVariables,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<TVariables>\n      ): [\n        QueryRef<TData, TVariables> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n  }\n\n  export namespace Signatures {\n    /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n    export interface Classic {\n      // _INFERENCE_ONLY_DO_NOT_SPECIFY is used to distinguish between inferred\n      // generics arguments and explicit generic arguments so that we can\n      // provide a `@deprecated` signature for explicit generic arguments. As\n      // soon as a user provides a generic arg (e.g. useBackgroundQuery<TData>(query))`,\n      // the overload falls through to the overloads without\n      // _INFERENCE_ONLY_DO_NOT_SPECIFY.\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          /** @deprecated `returnPartialData` has no effect on `no-cache` queries */\n          returnPartialData: boolean;\n          fetchPolicy: \"no-cache\";\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n          errorPolicy: TErrorPolicy & (\"ignore\" | \"all\");\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n          errorPolicy: TErrorPolicy & (\"ignore\" | \"all\");\n        }\n      ): [\n        QueryRef<\n          TData,\n          TVariables,\n          \"complete\" | \"streaming\" | \"partial\" | \"empty\"\n        >,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          errorPolicy: TErrorPolicy & (\"ignore\" | \"all\");\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: false;\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: boolean;\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          errorPolicy?: TErrorPolicy;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken\n      ): [undefined, useBackgroundQuery.Result<TData, TVariables>];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: false;\n              errorPolicy?: TErrorPolicy;\n            })\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: boolean;\n              errorPolicy?: TErrorPolicy;\n            })\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              errorPolicy?: TErrorPolicy;\n            },\n          ]\n        : [\n            options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              errorPolicy?: TErrorPolicy;\n            },\n          ]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?:\n              | SkipToken\n              | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n                  errorPolicy?: TErrorPolicy;\n                }),\n          ]\n        : [\n            options:\n              | SkipToken\n              | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n                  errorPolicy?: TErrorPolicy;\n                }),\n          ]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        _INFERENCE_ONLY_DO_NOT_SPECIFY extends \"inferred\",\n        TErrorPolicy extends ErrorPolicy | undefined = undefined,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              errorPolicy?: TErrorPolicy;\n            })\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables, TErrorPolicy>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          /** @deprecated `returnPartialData` has no effect on `no-cache` queries */\n          returnPartialData: boolean;\n          fetchPolicy: \"no-cache\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<\n          TData,\n          TVariables,\n          \"complete\" | \"streaming\" | \"partial\" | \"empty\"\n        >,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          errorPolicy: \"ignore\" | \"all\";\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"empty\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: false;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n          returnPartialData: boolean;\n        }\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: false;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          returnPartialData: boolean;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: useBackgroundQuery.Options<NoInfer<TVariables>> & {\n          skip: boolean;\n        }\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken\n      ): [undefined, useBackgroundQuery.Result<TData, TVariables>];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: false;\n            })\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options:\n          | SkipToken\n          | (useBackgroundQuery.Options<NoInfer<TVariables>> & {\n              returnPartialData: boolean;\n            })\n      ): [\n        (\n          | QueryRef<TData, TVariables, \"complete\" | \"streaming\" | \"partial\">\n          | undefined\n        ),\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [options?: useBackgroundQuery.Options<NoInfer<TVariables>>]\n        : [options: useBackgroundQuery.Options<NoInfer<TVariables>>]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\">,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?:\n              | SkipToken\n              | useBackgroundQuery.Options<NoInfer<TVariables>>,\n          ]\n        : [options: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>]\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery_Deprecated:call(1)} */\n      <TData, TVariables extends OperationVariables = OperationVariables>(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        options: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>\n      ): [\n        QueryRef<TData, TVariables, \"complete\" | \"streaming\"> | undefined,\n        useBackgroundQuery.Result<TData, TVariables>,\n      ];\n    }\n\n    /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n    export interface Modern {\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends never,\n      >(\n        query: {} extends TVariables ?\n          DocumentNode | TypedDocumentNode<TData, TVariables>\n        : // this overload should only be accessible if all `TVariables` are optional\n          never\n      ): useBackgroundQuery.ResultForOptions<\n        TData,\n        TVariables,\n        Record<string, never>\n      >;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends Base.Options,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?: TOptions &\n              useBackgroundQuery.OptionsFor<TVariables, TOptions>,\n          ]\n        : [\n            options: TOptions &\n              useBackgroundQuery.OptionsFor<TVariables, TOptions>,\n          ]\n      ): useBackgroundQuery.ResultForOptions<TData, TVariables, TOptions>;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends never,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        skipToken: SkipToken\n      ): useBackgroundQuery.ResultForOptions<TData, TVariables, SkipToken>;\n\n      /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n      <\n        TData,\n        TVariables extends OperationVariables,\n        // this overload should never be manually defined, it should always be inferred\n        TOptions extends Base.Options,\n      >(\n        query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n        ...[options]: {} extends TVariables ?\n          [\n            options?:\n              | (TOptions & useBackgroundQuery.OptionsFor<TVariables, TOptions>)\n              | SkipToken,\n          ]\n        : [\n            options:\n              | (TOptions & useBackgroundQuery.OptionsFor<TVariables, TOptions>)\n              | SkipToken,\n          ]\n      ): useBackgroundQuery.ResultForOptions<\n        TData,\n        TVariables,\n        TOptions | SkipToken\n      >;\n    }\n\n    export type Evaluated = SignatureStyle extends \"classic\" ? Classic : Modern;\n  }\n\n  /** {@inheritDoc @apollo/client/react!useBackgroundQuery.DocumentationTypes.useBackgroundQuery:call(1)} */\n  export interface Signature extends Signatures.Evaluated {}\n}\n\nexport const useBackgroundQuery: useBackgroundQuery.Signature =\n  function useBackgroundQuery<\n    TData = unknown,\n    TVariables extends OperationVariables = OperationVariables,\n  >(\n    query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n    options?: SkipToken | useBackgroundQuery.Options<NoInfer<TVariables>>\n  ): [\n    QueryRef<TData, TVariables, DataState<TData>[\"dataState\"]> | undefined,\n    useBackgroundQuery.Result<TData, TVariables>,\n  ] {\n    \"use no memo\";\n    return wrapHook(\n      \"useBackgroundQuery\",\n      useBackgroundQuery_,\n      useApolloClient(typeof options === \"object\" ? options.client : undefined)\n    )(query, options ?? ({} as any));\n  } as any;\n\nfunction useBackgroundQuery_<\n  TData = unknown,\n  TVariables extends OperationVariables = OperationVariables,\n  TStates extends DataState<TData>[\"dataState\"] = DataState<TData>[\"dataState\"],\n>(\n  query: DocumentNode | TypedDocumentNode<TData, TVariables>,\n  options:\n    | (SkipToken & Partial<useBackgroundQuery.Options<NoInfer<TVariables>>>)\n    | useBackgroundQuery.Options<NoInfer<TVariables>>\n): [\n  QueryRef<TData, TVariables, TStates> | undefined,\n  useBackgroundQuery.Result<TData, TVariables>,\n] {\n  const client = useApolloClient(options.client);\n  const suspenseCache = getSuspenseCache(client);\n  const watchQueryOptions = useWatchQueryOptions({ client, query, options });\n  const { fetchPolicy } = watchQueryOptions;\n  const cacheKey = useSuspenseHookCacheKey(query, options);\n\n  // This ref tracks the first time query execution is enabled to determine\n  // whether to return a query ref or `undefined`. When initialized\n  // in a skipped state (either via `skip: true` or `skipToken`) we return\n  // `undefined` for the `queryRef` until the query has been enabled. Once\n  // enabled, a query ref is always returned regardless of whether the query is\n  // skipped again later.\n  const didFetchResult = React.useRef(fetchPolicy !== \"standby\");\n  didFetchResult.current ||= fetchPolicy !== \"standby\";\n\n  const queryRef = suspenseCache.getQueryRef<TData, TStates>(cacheKey, () =>\n    client.watchQuery(\n      watchQueryOptions as ApolloClient.WatchQueryOptions<any, any>\n    )\n  );\n\n  const [wrappedQueryRef, setWrappedQueryRef] = React.useState(\n    wrapQueryRef(queryRef)\n  );\n  if (unwrapQueryRef(wrappedQueryRef) !== queryRef) {\n    setWrappedQueryRef(wrapQueryRef(queryRef));\n  }\n  if (queryRef.didChangeOptions(watchQueryOptions)) {\n    const promise = queryRef.applyOptions(watchQueryOptions);\n    updateWrappedQueryRef(wrappedQueryRef, promise);\n  }\n\n  // This prevents issues where rerendering useBackgroundQuery after the\n  // queryRef has been disposed would cause the hook to return a new queryRef\n  // instance since disposal also removes it from the suspense cache. We add\n  // the queryRef back in the suspense cache so that the next render will reuse\n  // this queryRef rather than initializing a new instance.\n  React.useEffect(() => {\n    // Since the queryRef is disposed async via `setTimeout`, we have to wait a\n    // tick before checking it and adding back to the suspense cache.\n    const id = setTimeout(() => {\n      if (queryRef.disposed) {\n        suspenseCache.add(cacheKey, queryRef);\n      }\n    });\n\n    return () => clearTimeout(id);\n    // Omitting the deps is intentional. This avoids stale closures and the\n    // conditional ensures we aren't running the logic on each render.\n  });\n\n  const fetchMore = React.useCallback(\n    (\n      options: ObservableQuery.FetchMoreOptions<TData, TVariables, any, any>\n    ) => {\n      const promise = queryRef.fetchMore(options);\n\n      setWrappedQueryRef(wrapQueryRef(queryRef));\n\n      return promise;\n    },\n    [queryRef]\n  ) as FetchMoreFunction<TData, TVariables>;\n\n  const refetch: RefetchFunction<TData, TVariables> = React.useCallback(\n    (variables) => {\n      const promise = queryRef.refetch(variables);\n\n      setWrappedQueryRef(wrapQueryRef(queryRef));\n\n      return promise;\n    },\n    [queryRef]\n  );\n\n  React.useEffect(() => queryRef.softRetain(), [queryRef]);\n\n  return [\n    didFetchResult.current ? wrappedQueryRef : void 0,\n    {\n      fetchMore,\n      refetch,\n      // TODO: The internalQueryRef doesn't have TVariables' type information so we have to cast it here\n      subscribeToMore: queryRef.observable\n        .subscribeToMore as SubscribeToMoreFunction<TData, TVariables>,\n    },\n  ];\n}\n"]}

package/react/hooks/useQuery.d.ts

@@ -144,7 +144,15 @@ export declare namespace useQuery {
     type Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> = Base.Options<TData, TVariables> & VariablesOption<TVariables>;
     namespace DocumentationTypes {
         namespace useQuery {
-            interface Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends Omit<Base.Options<TData, TVariables>, "variables">, UtilityDocumentationTypes.VariableOptions<TVariables> {
+            interface Options<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends Base.Options<TData, TVariables> {
+                /**
+                * An object containing all of the GraphQL variables your query requires to execute.
+                * 
+                * Each key in the object corresponds to a variable name, and that key's value corresponds to the variable value.
+                * 
+                * @docGroup 1. Operation options
+                */
+                variables?: TVariables;
             }
         }
     }