@apollo/client 4.0.0-rc.5 → 4.0.0-rc.7

package/__cjs/react/hooks/useSuspenseQuery.d.cts

@@ -1,4 +1,4 @@
-import type { ApolloClient, DataState, DefaultContext, DocumentNode, ErrorLike, ErrorPolicy, GetDataState, MaybeMasked, OperationVariables, RefetchWritePolicy, TypedDocumentNode, WatchQueryFetchPolicy, WatchQueryOptions } from "@apollo/client";
+import type { ApolloClient, DataState, DefaultContext, DocumentNode, ErrorLike, ErrorPolicy, GetDataState, MaybeMasked, OperationVariables, RefetchWritePolicy, TypedDocumentNode, WatchQueryFetchPolicy } from "@apollo/client";
 import type { SubscribeToMoreFunction } from "@apollo/client";
 import { NetworkStatus } from "@apollo/client";
 import type { FetchMoreFunction, RefetchFunction } from "@apollo/client/react/internal";
@@ -11,19 +11,16 @@ export declare namespace useSuspenseQuery {
             /**
             * The instance of `ApolloClient` to use to execute the query.
             * 
-            * By default, the instance that's passed down via context is used, but you can provide a different instance here.
+            * By default, the instance that's passed down via context is used, but you
+            * can provide a different instance here.
             * 
-            * @docGroup
-            * 
-            * 1. Operation options
+            * @docGroup 1. Operation options
             */
             client?: ApolloClient;
             /**
             * If you're using [Apollo Link](https://www.apollographql.com/docs/react/api/link/introduction/), this object is the initial value of the `context` object that's passed along your link chain.
             * 
-            * @docGroup
-            * 
-            * 2. Networking options
+            * @docGroup 2. Networking options
             */
             context?: DefaultContext;
             /**
@@ -33,9 +30,7 @@ export declare namespace useSuspenseQuery {
             * 
             * The default value is `none`, meaning that the query result includes error details but not partial results.
             * 
-            * @docGroup
-            * 
-            * 1. Operation options
+            * @docGroup 1. Operation options
             */
             errorPolicy?: ErrorPolicy;
             /**
@@ -43,9 +38,7 @@ export declare namespace useSuspenseQuery {
             * 
             * The default value is `false`.
             * 
-            * @docGroup
-            * 
-            * 3. Caching options
+            * @docGroup 3. Caching options
             */
             returnPartialData?: boolean;
             /**
@@ -53,9 +46,7 @@ export declare namespace useSuspenseQuery {
             * 
             * The default value is "overwrite".
             * 
-            * @docGroup
-            * 
-            * 3. Caching options
+            * @docGroup 3. Caching options
             */
             refetchWritePolicy?: RefetchWritePolicy;
             /**
@@ -65,40 +56,41 @@ export declare namespace useSuspenseQuery {
             * 
             * The default value is `cache-first`.
             * 
-            * @docGroup
-            * 
-            * 3. Caching options
+            * @docGroup 3. Caching options
             */
             fetchPolicy?: FetchPolicy;
             /**
-            * A unique identifier for the query. Each item in the array must be a stable identifier to prevent infinite fetches.
-            * 
-            * This is useful when using the same query and variables combination in more than one component, otherwise the components may clobber each other. This can also be used to force the query to re-evaluate fresh.
+            * A unique identifier for the query. Each item in the array must be a stable
+            * identifier to prevent infinite fetches.
             * 
-            * @docGroup
+            * This is useful when using the same query and variables combination in more
+            * than one component, otherwise the components may clobber each other. This
+            * can also be used to force the query to re-evaluate fresh.
             * 
-            * 1. Operation options
+            * @docGroup 1. Operation options
             */
             queryKey?: string | number | any[];
             /**
             * If `true`, the query is not executed. The default value is `false`.
             * 
-            * @deprecated
+            * @deprecated We recommend using `skipToken` in place of the `skip` option as
+            * it is more type-safe.
             * 
-            * 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.
-            * 
-            * @docGroup
-            * 
-            * 1. Operation options
+            * This option is deprecated and only supported to ease the migration from `useQuery`. It 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, useSuspenseQuery } from '@apollo/client';
+            * import { skipToken, useSuspenseQuery } from "@apollo/client";
             *
-            * const { data } = useSuspenseQuery(query, id ? { variables: { id } } : skipToken);
+            * const { data } = useSuspenseQuery(
+            *   query,
+            *   id ? { variables: { id } } : skipToken
+            * );
             * ```
             */
             skip?: boolean;
@@ -106,17 +98,9 @@ export declare namespace useSuspenseQuery {
     }
     type Options<TVariables extends OperationVariables = OperationVariables> = Base.Options<TVariables> & VariablesOption<TVariables>;
     namespace DocumentationTypes {
-        interface Options<TVariables extends OperationVariables = OperationVariables> extends Base.Options<TVariables> {
-            /**
-            * An object containing all of the GraphQL variables your query requires to execute.
-            * 
-            * Each key in the object corresponds to a variable name, and that key's value corresponds to the variable value.
-            * 
-            * @docGroup
-            * 
-            * 1. Operation options
-            */
-            variables?: TVariables;
+        namespace useSuspenseQuery {
+            interface Options<TVariables extends OperationVariables = OperationVariables> extends Base.Options<TVariables>, UtilityDocumentationTypes.VariableOptions<TVariables> {
+            }
         }
     }
     namespace Base {
@@ -124,30 +108,30 @@ export declare namespace useSuspenseQuery {
             /**
             * The instance of `ApolloClient` to use to execute the query.
             * 
-            * By default, the instance that's passed down via context is used, but you can provide a different instance here.
+            * By default, the instance that's passed down via context is used, but you
+            * can provide a different instance here.
             * 
-            * @docGroup
-            * 
-            * 1. Operation options
+            * @docGroup 1. Operation options
             */
             client: ApolloClient;
             /**
-            * A single ErrorLike object describing the error that occured during the latest query execution.
+            * A single ErrorLike object describing the error that occured during the latest
+            * query execution.
             * 
             * For more information, see [Handling operation errors](https://www.apollographql.com/docs/react/data/error-handling/).
             * 
-            * @docGroup
-            * 
-            * 1. Operation data
+            * @docGroup 1. Operation data
             */
             error: ErrorLike | undefined;
             /**
             * A function that helps you fetch the next set of results for a [paginated list field](https://www.apollographql.com/docs/react/pagination/core-api/).
+            *      
             * 
-            * 
-            * @docGroup
-            * 
-            * 3. Helper functions
+            * @docGroup 3. Helper functions
+            *      
+            *
+            * @remarks
+            * Calling this function will cause the component to re-suspend, unless the call site is wrapped in [`startTransition`](https://react.dev/reference/react/startTransition).
             */
             fetchMore: FetchMoreFunction<TData, TVariables>;
             /**
@@ -155,9 +139,7 @@ export declare namespace useSuspenseQuery {
             * 
             * Used in conjunction with the [`notifyOnNetworkStatusChange`](#notifyonnetworkstatuschange) option.
             * 
-            * @docGroup
-            * 
-            * 2. Network info
+            * @docGroup 2. Network info
             */
             networkStatus: NetworkStatus;
             /**
@@ -167,62 +149,482 @@ export declare namespace useSuspenseQuery {
             * 
             * See also [Refetching](https://www.apollographql.com/docs/react/data/queries/#refetching).
             * 
-            * @docGroup
+            * Returns a `ResultPromise` with an additional `.retain()` method. Calling
+            * `.retain()` keeps the network operation running even if the `ObservableQuery`
+            * no longer requires the result.
             * 
-            * 3. Helper functions
+            * @docGroup 3. Helper functions
+            *      
+            *
+            * @remarks
+            * Calling this function will cause the component to re-suspend, unless the call site is wrapped in [`startTransition`](https://react.dev/reference/react/startTransition).
             */
             refetch: RefetchFunction<TData, TVariables>;
             /**
             * A function that enables you to execute a [subscription](https://www.apollographql.com/docs/react/data/subscriptions/), usually to subscribe to specific fields that were included in the query.
             * 
             * This function returns _another_ function that you can call to terminate the subscription.
+            *      
             * 
-            * 
-            * @docGroup
-            * 
-            * 3. Helper functions
+            * @docGroup 3. Helper functions
             */
             subscribeToMore: SubscribeToMoreFunction<TData, TVariables>;
         }
     }
     type Result<TData = unknown, TVariables extends OperationVariables = OperationVariables, TStates extends DataState<TData>["dataState"] = DataState<TData>["dataState"]> = Base.Result<TData, TVariables> & GetDataState<MaybeMasked<TData>, TStates>;
     namespace DocumentationTypes {
-        interface Result<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends Base.Result<TData, TVariables>, UtilityDocumentationTypes.DataState<TData> {
+        namespace useSuspenseQuery {
+            interface Result<TData = unknown, TVariables extends OperationVariables = OperationVariables> extends Base.Result<TData, TVariables>, UtilityDocumentationTypes.DataState<TData> {
+            }
         }
     }
+    namespace DocumentationTypes {
+        /**
+        * Test 
+        * For a detailed explanation of `useSuspenseQuery`, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).
+        * 
+        * @example
+        * 
+        * ```jsx
+        * import { Suspense } from "react";
+        * import { useSuspenseQuery } from "@apollo/client";
+        * 
+        * const listQuery = gql`
+        *   query {
+        *     list {
+        *       id
+        *     }
+        *   }
+        * `;
+        * 
+        * function App() {
+        *   return (
+        *     <Suspense fallback={<Spinner />}>
+        *       <List />
+        *     </Suspense>
+        *   );
+        * }
+        * 
+        * function List() {
+        *   const { data } = useSuspenseQuery(listQuery);
+        * 
+        *   return (
+        *     <ol>
+        *       {data.list.map((item) => (
+        *         <Item key={item.id} id={item.id} />
+        *       ))}
+        *     </ol>
+        *   );
+        * }
+        * ```
+        * 
+        * @param query - A GraphQL query document parsed into an AST by `gql`.
+        * @param options - An optional object containing options for the query. Instead of passing a `useSuspenseQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useSuspenseQuery` hook from executing the query or suspending.
+        */
+        function useSuspenseQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options?: useSuspenseQuery.Options<TVariables>): useSuspenseQuery.Result<TData, TVariables>;
+    }
 }
+/**
+ * For a detailed explanation of `useSuspenseQuery`, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).
+ *
+ * @example
+ *
+ * ```jsx
+ * import { Suspense } from "react";
+ * import { useSuspenseQuery } from "@apollo/client";
+ *
+ * const listQuery = gql`
+ *   query {
+ *     list {
+ *       id
+ *     }
+ *   }
+ * `;
+ *
+ * function App() {
+ *   return (
+ *     <Suspense fallback={<Spinner />}>
+ *       <List />
+ *     </Suspense>
+ *   );
+ * }
+ *
+ * function List() {
+ *   const { data } = useSuspenseQuery(listQuery);
+ *
+ *   return (
+ *     <ol>
+ *       {data.list.map((item) => (
+ *         <Item key={item.id} id={item.id} />
+ *       ))}
+ *     </ol>
+ *   );
+ * }
+ * ```
+ *
+ * @param query - A GraphQL query document parsed into an AST by `gql`.
+ * @param options - An optional object containing options for the query. Instead of passing a `useSuspenseQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useSuspenseQuery` hook from executing the query or suspending.
+ */
 export declare function useSuspenseQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useSuspenseQuery.Options<NoInfer<TVariables>> & {
     returnPartialData: true;
     errorPolicy: "ignore" | "all";
 }): useSuspenseQuery.Result<TData, TVariables, "complete" | "streaming" | "partial" | "empty">;
+/**
+* For a detailed explanation of `useSuspenseQuery`, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).
+* 
+* @example
+* 
+* ```jsx
+* import { Suspense } from "react";
+* import { useSuspenseQuery } from "@apollo/client";
+* 
+* const listQuery = gql`
+*   query {
+*     list {
+*       id
+*     }
+*   }
+* `;
+* 
+* function App() {
+*   return (
+*     <Suspense fallback={<Spinner />}>
+*       <List />
+*     </Suspense>
+*   );
+* }
+* 
+* function List() {
+*   const { data } = useSuspenseQuery(listQuery);
+* 
+*   return (
+*     <ol>
+*       {data.list.map((item) => (
+*         <Item key={item.id} id={item.id} />
+*       ))}
+*     </ol>
+*   );
+* }
+* ```
+* 
+* @param query - A GraphQL query document parsed into an AST by `gql`.
+* @param options - An optional object containing options for the query. Instead of passing a `useSuspenseQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useSuspenseQuery` hook from executing the query or suspending.
+*/
 export declare function useSuspenseQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useSuspenseQuery.Options<NoInfer<TVariables>> & {
     errorPolicy: "ignore" | "all";
 }): useSuspenseQuery.Result<TData, TVariables, "complete" | "streaming" | "empty">;
+/**
+* For a detailed explanation of `useSuspenseQuery`, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).
+* 
+* @example
+* 
+* ```jsx
+* import { Suspense } from "react";
+* import { useSuspenseQuery } from "@apollo/client";
+* 
+* const listQuery = gql`
+*   query {
+*     list {
+*       id
+*     }
+*   }
+* `;
+* 
+* function App() {
+*   return (
+*     <Suspense fallback={<Spinner />}>
+*       <List />
+*     </Suspense>
+*   );
+* }
+* 
+* function List() {
+*   const { data } = useSuspenseQuery(listQuery);
+* 
+*   return (
+*     <ol>
+*       {data.list.map((item) => (
+*         <Item key={item.id} id={item.id} />
+*       ))}
+*     </ol>
+*   );
+* }
+* ```
+* 
+* @param query - A GraphQL query document parsed into an AST by `gql`.
+* @param options - An optional object containing options for the query. Instead of passing a `useSuspenseQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useSuspenseQuery` hook from executing the query or suspending.
+*/
 export declare function useSuspenseQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useSuspenseQuery.Options<NoInfer<TVariables>> & {
     skip: boolean;
     returnPartialData: true;
 }): useSuspenseQuery.Result<TData, TVariables, "complete" | "empty" | "streaming" | "partial">;
+/**
+* For a detailed explanation of `useSuspenseQuery`, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).
+* 
+* @example
+* 
+* ```jsx
+* import { Suspense } from "react";
+* import { useSuspenseQuery } from "@apollo/client";
+* 
+* const listQuery = gql`
+*   query {
+*     list {
+*       id
+*     }
+*   }
+* `;
+* 
+* function App() {
+*   return (
+*     <Suspense fallback={<Spinner />}>
+*       <List />
+*     </Suspense>
+*   );
+* }
+* 
+* function List() {
+*   const { data } = useSuspenseQuery(listQuery);
+* 
+*   return (
+*     <ol>
+*       {data.list.map((item) => (
+*         <Item key={item.id} id={item.id} />
+*       ))}
+*     </ol>
+*   );
+* }
+* ```
+* 
+* @param query - A GraphQL query document parsed into an AST by `gql`.
+* @param options - An optional object containing options for the query. Instead of passing a `useSuspenseQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useSuspenseQuery` hook from executing the query or suspending.
+*/
 export declare function useSuspenseQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useSuspenseQuery.Options<NoInfer<TVariables>> & {
     returnPartialData: true;
 }): useSuspenseQuery.Result<TData, TVariables, "partial" | "streaming" | "complete">;
+/**
+* For a detailed explanation of `useSuspenseQuery`, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).
+* 
+* @example
+* 
+* ```jsx
+* import { Suspense } from "react";
+* import { useSuspenseQuery } from "@apollo/client";
+* 
+* const listQuery = gql`
+*   query {
+*     list {
+*       id
+*     }
+*   }
+* `;
+* 
+* function App() {
+*   return (
+*     <Suspense fallback={<Spinner />}>
+*       <List />
+*     </Suspense>
+*   );
+* }
+* 
+* function List() {
+*   const { data } = useSuspenseQuery(listQuery);
+* 
+*   return (
+*     <ol>
+*       {data.list.map((item) => (
+*         <Item key={item.id} id={item.id} />
+*       ))}
+*     </ol>
+*   );
+* }
+* ```
+* 
+* @param query - A GraphQL query document parsed into an AST by `gql`.
+* @param options - An optional object containing options for the query. Instead of passing a `useSuspenseQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useSuspenseQuery` hook from executing the query or suspending.
+*/
 export declare function useSuspenseQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: useSuspenseQuery.Options<NoInfer<TVariables>> & {
     skip: boolean;
 }): useSuspenseQuery.Result<TData, TVariables, "complete" | "streaming" | "empty">;
+/**
+* For a detailed explanation of `useSuspenseQuery`, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).
+* 
+* @example
+* 
+* ```jsx
+* import { Suspense } from "react";
+* import { useSuspenseQuery } from "@apollo/client";
+* 
+* const listQuery = gql`
+*   query {
+*     list {
+*       id
+*     }
+*   }
+* `;
+* 
+* function App() {
+*   return (
+*     <Suspense fallback={<Spinner />}>
+*       <List />
+*     </Suspense>
+*   );
+* }
+* 
+* function List() {
+*   const { data } = useSuspenseQuery(listQuery);
+* 
+*   return (
+*     <ol>
+*       {data.list.map((item) => (
+*         <Item key={item.id} id={item.id} />
+*       ))}
+*     </ol>
+*   );
+* }
+* ```
+* 
+* @param query - A GraphQL query document parsed into an AST by `gql`.
+* @param options - An optional object containing options for the query. Instead of passing a `useSuspenseQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useSuspenseQuery` hook from executing the query or suspending.
+*/
 export declare function useSuspenseQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: SkipToken | (useSuspenseQuery.Options<NoInfer<TVariables>> & {
     returnPartialData: true;
 })): useSuspenseQuery.Result<TData, TVariables, "empty" | "streaming" | "complete" | "partial">;
+/**
+* For a detailed explanation of `useSuspenseQuery`, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).
+* 
+* @example
+* 
+* ```jsx
+* import { Suspense } from "react";
+* import { useSuspenseQuery } from "@apollo/client";
+* 
+* const listQuery = gql`
+*   query {
+*     list {
+*       id
+*     }
+*   }
+* `;
+* 
+* function App() {
+*   return (
+*     <Suspense fallback={<Spinner />}>
+*       <List />
+*     </Suspense>
+*   );
+* }
+* 
+* function List() {
+*   const { data } = useSuspenseQuery(listQuery);
+* 
+*   return (
+*     <ol>
+*       {data.list.map((item) => (
+*         <Item key={item.id} id={item.id} />
+*       ))}
+*     </ol>
+*   );
+* }
+* ```
+* 
+* @param query - A GraphQL query document parsed into an AST by `gql`.
+* @param options - An optional object containing options for the query. Instead of passing a `useSuspenseQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useSuspenseQuery` hook from executing the query or suspending.
+*/
 export declare function useSuspenseQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, ...[options]: {} extends TVariables ? [
     options?: useSuspenseQuery.Options<NoInfer<TVariables>>
 ] : [options: useSuspenseQuery.Options<NoInfer<TVariables>>]): useSuspenseQuery.Result<TData, TVariables, "complete" | "streaming">;
+/**
+* For a detailed explanation of `useSuspenseQuery`, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).
+* 
+* @example
+* 
+* ```jsx
+* import { Suspense } from "react";
+* import { useSuspenseQuery } from "@apollo/client";
+* 
+* const listQuery = gql`
+*   query {
+*     list {
+*       id
+*     }
+*   }
+* `;
+* 
+* function App() {
+*   return (
+*     <Suspense fallback={<Spinner />}>
+*       <List />
+*     </Suspense>
+*   );
+* }
+* 
+* function List() {
+*   const { data } = useSuspenseQuery(listQuery);
+* 
+*   return (
+*     <ol>
+*       {data.list.map((item) => (
+*         <Item key={item.id} id={item.id} />
+*       ))}
+*     </ol>
+*   );
+* }
+* ```
+* 
+* @param query - A GraphQL query document parsed into an AST by `gql`.
+* @param options - An optional object containing options for the query. Instead of passing a `useSuspenseQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useSuspenseQuery` hook from executing the query or suspending.
+*/
 export declare function useSuspenseQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, ...[options]: {} extends TVariables ? [
     options?: SkipToken | useSuspenseQuery.Options<NoInfer<TVariables>>
 ] : [options: SkipToken | useSuspenseQuery.Options<NoInfer<TVariables>>]): useSuspenseQuery.Result<TData, TVariables, "complete" | "streaming" | "empty">;
+/**
+* For a detailed explanation of `useSuspenseQuery`, see the [fetching with Suspense reference](https://www.apollographql.com/docs/react/data/suspense).
+* 
+* @example
+* 
+* ```jsx
+* import { Suspense } from "react";
+* import { useSuspenseQuery } from "@apollo/client";
+* 
+* const listQuery = gql`
+*   query {
+*     list {
+*       id
+*     }
+*   }
+* `;
+* 
+* function App() {
+*   return (
+*     <Suspense fallback={<Spinner />}>
+*       <List />
+*     </Suspense>
+*   );
+* }
+* 
+* function List() {
+*   const { data } = useSuspenseQuery(listQuery);
+* 
+*   return (
+*     <ol>
+*       {data.list.map((item) => (
+*         <Item key={item.id} id={item.id} />
+*       ))}
+*     </ol>
+*   );
+* }
+* ```
+* 
+* @param query - A GraphQL query document parsed into an AST by `gql`.
+* @param options - An optional object containing options for the query. Instead of passing a `useSuspenseQuery.Options` object into the hook, you can also pass a [`skipToken`](#skiptoken) to prevent the `useSuspenseQuery` hook from executing the query or suspending.
+*/
 export declare function useSuspenseQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(query: DocumentNode | TypedDocumentNode<TData, TVariables>, options: SkipToken | useSuspenseQuery.Options<NoInfer<TVariables>>): useSuspenseQuery.Result<TData, TVariables, "complete" | "streaming" | "empty">;
 interface UseWatchQueryOptionsHookOptions<TData, TVariables extends OperationVariables> {
     client: ApolloClient;
     query: DocumentNode | TypedDocumentNode<TData, TVariables>;
     options: SkipToken | useSuspenseQuery.Options<TVariables>;
 }
-export declare function useWatchQueryOptions<TData, TVariables extends OperationVariables>({ client, query, options, }: UseWatchQueryOptionsHookOptions<TData, TVariables>): WatchQueryOptions<TVariables, TData>;
+export declare function useWatchQueryOptions<TData, TVariables extends OperationVariables>({ client, query, options, }: UseWatchQueryOptionsHookOptions<TData, TVariables>): ApolloClient.WatchQueryOptions<TData, TVariables>;
 export {};
 //# sourceMappingURL=useSuspenseQuery.d.cts.map