@apollo/client 4.3.0-rc.0 → 4.3.0-rc.2

package/link/core/ApolloLink.js

@@ -100,7 +100,7 @@ export class ApolloLink {
             const result = test(operation);
             if (__DEV__) {
                 if (typeof result !== "boolean") {
-                    __DEV__ && invariant.warn(64, result);
+                    __DEV__ && invariant.warn(65, result);
                 }
             }
             return result ?
@@ -142,7 +142,7 @@ export class ApolloLink {
     static execute(link, request, context) {
         return link.request(createOperation(request, context), () => {
             if (__DEV__) {
-                __DEV__ && invariant.warn(65);
+                __DEV__ && invariant.warn(66);
             }
             return EMPTY;
         });
@@ -246,7 +246,7 @@ export class ApolloLink {
      * > request instead.
      */
     request(operation, forward) {
-        throw newInvariantError(66);
+        throw newInvariantError(67);
     }
     /**
     * @internal

package/link/http/checkFetcher.js

@@ -1,5 +1,5 @@
 import { invariant } from "@apollo/client/utilities/invariant";
 export const checkFetcher = (fetcher) => {
-    invariant(fetcher || typeof fetch !== "undefined", 62);
+    invariant(fetcher || typeof fetch !== "undefined", 63);
 };
 //# sourceMappingURL=checkFetcher.js.map

package/link/http/parseAndCheckHttpResponse.js

@@ -33,7 +33,7 @@ async function* consumeMultipartBody(response) {
     /;\s*boundary=(?:'([^']+)'|"([^"]+)"|([^"'].+?))\s*(?:;|$)/i);
     const boundary = "\r\n--" + (match ? match[1] ?? match[2] ?? match[3] ?? "-" : "-");
     let buffer = "";
-    invariant(response.body && typeof response.body.getReader === "function", 63);
+    invariant(response.body && typeof response.body.getReader === "function", 64);
     const stream = response.body;
     const reader = stream.getReader();
     let done = false;

package/link/persisted-queries/index.js

@@ -66,7 +66,7 @@ export class PersistedQueryLink extends ApolloLink {
         // hashing with something other than SHA-256.
         invariant(options &&
             (typeof options.sha256 === "function" ||
-                typeof options.generateHash === "function"), 60);
+                typeof options.generateHash === "function"), 61);
         const { sha256, 
         // If both a `sha256` and `generateHash` option are provided, the
         // `sha256` option will be ignored. Developers can configure and
@@ -92,7 +92,7 @@ export class PersistedQueryLink extends ApolloLink {
             return hash;
         }
         super((operation, forward) => {
-            invariant(forward, 61);
+            invariant(forward, 62);
             const { query } = operation;
             return new Observable((observer) => {
                 let subscription;

package/link/ws/index.js

@@ -33,7 +33,7 @@ export class WebSocketLink extends ApolloLink {
     constructor(paramsOrClient) {
         super();
         if (__DEV__) {
-            __DEV__ && invariant.warn(59);
+            __DEV__ && invariant.warn(60);
         }
         if (paramsOrClient instanceof SubscriptionClient) {
             this.subscriptionClient = paramsOrClient;

package/local-state/LocalState.js

@@ -66,7 +66,7 @@ export class LocalState {
     }
     async execute({ document, client, context, remoteResult, variables = {}, onlyRunForcedResolvers = false, returnPartialData = false, fetchPolicy, }) {
         if (__DEV__) {
-            invariant(hasDirectives(["client"], document), 48);
+            invariant(hasDirectives(["client"], document), 49);
             validateCacheImplementation(client.cache);
         }
         // note: if `remoteResult` is `undefined`, we will execute resolvers since
@@ -122,7 +122,7 @@ export class LocalState {
     }
     async getExportedVariables({ document, client, context, variables, }) {
         if (__DEV__) {
-            invariant(hasDirectives(["client"], document), 49);
+            invariant(hasDirectives(["client"], document), 50);
             validateCacheImplementation(client.cache);
         }
         const { exportsToResolve, exportedVariableDefs, fragmentMap, operationDefinition, } = this.collectQueryDetail(document);
@@ -204,7 +204,7 @@ export class LocalState {
             }
             if (selection.kind === Kind.FRAGMENT_SPREAD) {
                 const fragment = fragmentMap[selection.name.value];
-                invariant(fragment, 50, selection.name.value);
+                invariant(fragment, 51, selection.name.value);
                 const typename = rootValue?.__typename;
                 const typeCondition = fragment.typeCondition.name.value;
                 const matches = typename === typeCondition ||
@@ -269,7 +269,7 @@ export class LocalState {
                 }
                 if (client.cache.resolvesClientField?.(typename, fieldName)) {
                     if (fetchPolicy === "no-cache") {
-                        __DEV__ && invariant.warn(51, resolverName);
+                        __DEV__ && invariant.warn(52, resolverName);
                         return null;
                     }
                     // assume the cache will handle returning the correct value
@@ -277,7 +277,7 @@ export class LocalState {
                     return;
                 }
                 if (!returnPartialData) {
-                    __DEV__ && invariant.warn(52, resolverName);
+                    __DEV__ && invariant.warn(53, resolverName);
                     return null;
                 }
             });
@@ -343,13 +343,13 @@ export class LocalState {
         if (result === undefined && !returnPartialData) {
             if (__DEV__ && phase === "resolve") {
                 if (resolver && !onlyRunForcedResolvers) {
-                    __DEV__ && invariant.warn(53, resolverName);
+                    __DEV__ && invariant.warn(54, resolverName);
                 }
                 else if (onlyRunForcedResolvers) {
-                    __DEV__ && invariant.warn(54, resolverName);
+                    __DEV__ && invariant.warn(55, resolverName);
                 }
                 else {
-                    __DEV__ && invariant.warn(55, fieldName, rootValue);
+                    __DEV__ && invariant.warn(56, fieldName, rootValue);
                 }
             }
             result = null;
@@ -361,7 +361,7 @@ export class LocalState {
             return this.resolveSubSelectedArray(field, true, result, execContext, path);
         }
         if (phase === "resolve" && !result.__typename) {
-            this.addError(newInvariantError(56, result, resolverName), path, execContext, { resolver: resolverName });
+            this.addError(newInvariantError(57, result, resolverName), path, execContext, { resolver: resolverName });
             return null;
         }
         return this.resolveSelectionSet(field.selectionSet, true, result, execContext, path);
@@ -472,7 +472,7 @@ export class LocalState {
                 },
                 FragmentSpread(spread, _, __, ___, ancestors) {
                     const fragment = fragmentMap[spread.name.value];
-                    invariant(fragment, 57, spread.name.value);
+                    invariant(fragment, 58, spread.name.value);
                     const { selectionsToResolve: fragmentSelections } = traverse(fragment);
                     if (fragmentSelections.size > 0) {
                         // Fragment for this spread contains @client directive (either directly or transitively)
@@ -531,7 +531,7 @@ function getExportedVariableName(directive) {
     }
 }
 function validateCacheImplementation(cache) {
-    invariant(cache.fragmentMatches, 58);
+    invariant(cache.fragmentMatches, 59);
 }
 function getCacheResultAtPath(diff, path) {
     if (diff.result === null) {

package/masking/maskDefinition.js

@@ -86,7 +86,7 @@ function maskSelectionSet(data, selectionSet, context, migration, path) {
             const fragment = context.fragmentMap[fragmentName] ||
                 (context.fragmentMap[fragmentName] =
                     context.cache.lookupFragment(fragmentName));
-            invariant(fragment, 40, fragmentName);
+            invariant(fragment, 41, fragmentName);
             const mode = getFragmentMaskMode(selection);
             if (mode !== "mask") {
                 value = maskSelectionSet(data, fragment.selectionSet, context, mode === "migrate", path);
@@ -112,7 +112,7 @@ function getAccessorWarningDescriptor(fieldName, value, path, operationName, ope
         if (disableWarningsSlot.getValue()) {
             return value;
         }
-        __DEV__ && invariant.warn(41, operationName ?
+        __DEV__ && invariant.warn(42, operationName ?
             `${operationType} '${operationName}'`
             : `anonymous ${operationType}`, `${path}.${fieldName}`.replace(/^\./, ""));
         getValue = () => value;

package/masking/maskFragment.js

@@ -11,11 +11,11 @@ import { maskDefinition } from "./maskDefinition.js";
 export function maskFragment(data, document, cache, fragmentName) {
     const fragments = document.definitions.filter((node) => node.kind === Kind.FRAGMENT_DEFINITION);
     if (typeof fragmentName === "undefined") {
-        invariant(fragments.length === 1, 42, fragments.length);
+        invariant(fragments.length === 1, 43, fragments.length);
         fragmentName = fragments[0].name.value;
     }
     const fragment = fragments.find((fragment) => fragment.name.value === fragmentName);
-    invariant(!!fragment, 43, fragmentName);
+    invariant(!!fragment, 44, fragmentName);
     if (data == null) {
         // Maintain the original `null` or `undefined` value
         return data;

package/masking/maskOperation.js

@@ -8,7 +8,7 @@ import { maskDefinition } from "./maskDefinition.js";
 */
 export function maskOperation(data, document, cache) {
     const definition = getOperationDefinition(document);
-    invariant(definition, 44);
+    invariant(definition, 45);
     if (data == null) {
         // Maintain the original `null` or `undefined` value
         return data;

package/masking/utils.js

@@ -19,13 +19,13 @@ export function getFragmentMaskMode(fragment) {
     if (__DEV__) {
         if (modeArg) {
             if (modeArg.value.kind === Kind.VARIABLE) {
-                __DEV__ && invariant.warn(45);
+                __DEV__ && invariant.warn(46);
             }
             else if (modeArg.value.kind !== Kind.STRING) {
-                __DEV__ && invariant.warn(46);
+                __DEV__ && invariant.warn(47);
             }
             else if (modeArg.value.value !== "migrate") {
-                __DEV__ && invariant.warn(47, modeArg.value.value);
+                __DEV__ && invariant.warn(48, modeArg.value.value);
             }
         }
     }

package/package.json

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

package/react/context/ApolloContext.js

@@ -6,7 +6,7 @@ import { invariant } from "@apollo/client/utilities/invariant";
 // context), a single Apollo context is created and tracked in global state.
 const contextKey = Symbol.for("__APOLLO_CONTEXT__");
 export function getApolloContext() {
-    invariant("createContext" in React, 38);
+    invariant("createContext" in React, 39);
     let context = React.createContext[contextKey];
     if (!context) {
         Object.defineProperty(React.createContext, contextKey, {

package/react/context/ApolloProvider.js

@@ -10,7 +10,7 @@ export const ApolloProvider = ({ client, children, }) => {
             client: client || parentContext.client,
         };
     }, [parentContext, client]);
-    invariant(context.client, 39);
+    invariant(context.client, 40);
     return (React.createElement(ApolloContext.Provider, { value: context }, children));
 };
 //# sourceMappingURL=ApolloProvider.js.map

package/react/hooks/internal/validateSuspenseHookOptions.js

@@ -12,11 +12,11 @@ function validateFetchPolicy(fetchPolicy = "cache-first") {
         "no-cache",
         "cache-and-network",
     ];
-    invariant(supportedFetchPolicies.includes(fetchPolicy), 36, fetchPolicy);
+    invariant(supportedFetchPolicies.includes(fetchPolicy), 37, fetchPolicy);
 }
 function validatePartialDataReturn(fetchPolicy, returnPartialData) {
     if (fetchPolicy === "no-cache" && returnPartialData) {
-        __DEV__ && invariant.warn(37);
+        __DEV__ && invariant.warn(38);
     }
 }
 //# sourceMappingURL=validateSuspenseHookOptions.js.map

package/react/hooks/useApolloClient.js

@@ -19,7 +19,7 @@ import { getApolloContext } from "../context/ApolloContext.js";
 export function useApolloClient(override) {
     const context = React.useContext(getApolloContext());
     const client = override || context.client;
-    invariant(!!client, 29);
+    invariant(!!client, 30);
     return client;
 }
 //# sourceMappingURL=useApolloClient.js.map

package/react/hooks/useBackgroundQuery.d.ts

@@ -96,7 +96,7 @@ export declare namespace useBackgroundQuery {
             * @deprecated We recommend using `skipToken` in place of the `skip` option as
             * it is more type-safe.
             * 
-            * This option is deprecated and only supported to ease the migration from `useQuery`. It will be removed in a future release.
+            * This option is deprecated and will be removed in a future release.
             * Please use [`skipToken`](https://www.apollographql.com/docs/react/api/react/hooks#skiptoken) instead of the `skip` option as it is more type-safe.
             * 
             * @docGroup 1. Operation options
@@ -105,7 +105,7 @@ export declare namespace useBackgroundQuery {
             * @example Recommended usage of `skipToken`:
             *
             * ```ts
-            * import { skipToken, useBackgroundQuery } from "@apollo/client";
+            * import { skipToken, useBackgroundQuery } from "@apollo/client/react";
             *
             * const [queryRef] = useBackgroundQuery(
             *   query,

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;AASvC,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  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"]}
+{"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;AASvC,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  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/react\";\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/useLazyQuery.js

@@ -65,7 +65,7 @@ export const useLazyQuery = function useLazyQuery(query, options) {
         const eagerMethods = {};
         for (const key of EAGER_METHODS) {
             eagerMethods[key] = function (...args) {
-                invariant(resultRef.current, 30, key);
+                invariant(resultRef.current, 31, key);
                 // @ts-expect-error this is just to generic to type
                 return observable[key](...args);
             };
@@ -103,7 +103,7 @@ export const useLazyQuery = function useLazyQuery(query, options) {
         options?.skipPollAttempt,
     ]);
     const execute = React.useCallback((...args) => {
-        invariant(!calledDuringRender(), 31);
+        invariant(!calledDuringRender(), 32);
         const [executeOptions] = args;
         let fetchPolicy = observable.options.fetchPolicy;
         if (fetchPolicy === "standby") {

package/react/hooks/useLoadableQuery.js

@@ -36,7 +36,7 @@ export const useLoadableQuery = function useLoadableQuery(query, options = {}) {
         return promise;
     }, [internalQueryRef]);
     const loadQuery = React.useCallback((...args) => {
-        invariant(!calledDuringRender(), 32);
+        invariant(!calledDuringRender(), 33);
         const [variables] = args;
         const cacheKey = [
             query,
@@ -57,7 +57,7 @@ export const useLoadableQuery = function useLoadableQuery(query, options = {}) {
         client,
     ]);
     const subscribeToMore = React.useCallback((options) => {
-        invariant(internalQueryRef, 33);
+        invariant(internalQueryRef, 34);
         return internalQueryRef.observable.subscribeToMore(
         // TODO: The internalQueryRef doesn't have TVariables' type information so we have to cast it here
         options);

package/react/hooks/useQuery.d.ts

@@ -105,11 +105,24 @@ export declare namespace useQuery {
             */
             context?: DefaultContext;
             /**
-            * If true, the query is not executed.
+            * If `true`, the query is not executed. The default value is `false`.
             * 
-            * The default value is `false`.
+            * @deprecated We recommend using `skipToken` in place of the `skip` option as
+            * it is more type-safe.
+            * 
+            * This option is deprecated and will be removed in a future release.
+            * Please use [`skipToken`](https://www.apollographql.com/docs/react/api/react/hooks#skiptoken) instead of the `skip` option as it is more type-safe.
             * 
             * @docGroup 1. Operation options
+            *      
+            *
+            * @example Recommended usage of `skipToken`:
+            *
+            * ```ts
+            * import { skipToken, useQuery } from "@apollo/client/react";
+            *
+            * const { data } = useQuery(query, id ? { variables: { id } } : skipToken);
+            * ```
             */
             skip?: boolean;
             /**