@apollo/client 4.0.0-rc.6 → 4.0.0-rc.8

package/core/ObservableQuery.d.ts

@@ -18,33 +18,30 @@ export declare namespace ObservableQuery {
         * 
         * The default value is `cache-first`.
         * 
-        * @docGroup
-        * 
-        * 3. Caching options
+        * @docGroup 3. Caching options
         */
         fetchPolicy: WatchQueryFetchPolicy;
         /**
         * Specifies the `FetchPolicy` to be used after this query has completed.
         * 
-        * @docGroup
-        * 
-        * 3. Caching options
+        * @docGroup 3. Caching options
         */
         nextFetchPolicy?: WatchQueryFetchPolicy | ((this: ApolloClient.WatchQueryOptions<TData, TVariables>, currentFetchPolicy: WatchQueryFetchPolicy, context: NextFetchPolicyContext<TData, TVariables>) => WatchQueryFetchPolicy);
         /**
-        * Defaults to the initial value of options.fetchPolicy, but can be explicitly configured to specify the WatchQueryFetchPolicy to revert back to whenever variables change (unless nextFetchPolicy intervenes).
+        * Defaults to the initial value of options.fetchPolicy, but can be explicitly
+        * configured to specify the WatchQueryFetchPolicy to revert back to whenever
+        * variables change (unless nextFetchPolicy intervenes).
         * 
-        * @docGroup
-        * 
-        * 3. Caching options
+        * @docGroup 3. Caching options
         */
         initialFetchPolicy: WatchQueryFetchPolicy;
         /**
-        * Specifies whether a `NetworkStatus.refetch` operation should merge incoming field data with existing data, or overwrite the existing data. Overwriting is probably preferable, but merging is currently the default behavior, for backwards compatibility with Apollo Client 3.x.
-        * 
-        * @docGroup
+        * Specifies whether a `NetworkStatus.refetch` operation should merge
+        * incoming field data with existing data, or overwrite the existing data.
+        * Overwriting is probably preferable, but merging is currently the default
+        * behavior, for backwards compatibility with Apollo Client 3.x.
         * 
-        * 3. Caching options
+        * @docGroup 3. Caching options
         */
         refetchWritePolicy?: RefetchWritePolicy;
         /**
@@ -54,17 +51,13 @@ export declare namespace ObservableQuery {
         * 
         * 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;
         /**
         * 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;
         /**
@@ -72,9 +65,7 @@ export declare namespace ObservableQuery {
         * 
         * The default value is `0` (no polling).
         * 
-        * @docGroup
-        * 
-        * 2. Networking options
+        * @docGroup 2. Networking options
         */
         pollInterval?: number;
         /**
@@ -82,9 +73,7 @@ export declare namespace ObservableQuery {
         * 
         * The default value is `true`.
         * 
-        * @docGroup
-        * 
-        * 2. Networking options
+        * @docGroup 2. Networking options
         */
         notifyOnNetworkStatusChange?: boolean;
         /**
@@ -92,25 +81,21 @@ export declare namespace ObservableQuery {
         * 
         * The default value is `false`.
         * 
-        * @docGroup
-        * 
-        * 3. Caching options
+        * @docGroup 3. Caching options
         */
         returnPartialData?: boolean;
         /**
-        * A callback function that's called whenever a refetch attempt occurs while polling. If the function returns `true`, the refetch is skipped and not reattempted until the next poll interval.
+        * A callback function that's called whenever a refetch attempt occurs
+        * while polling. If the function returns `true`, the refetch is
+        * skipped and not reattempted until the next poll interval.
         * 
-        * @docGroup
-        * 
-        * 2. Networking options
+        * @docGroup 2. Networking options
         */
         skipPollAttempt?: () => boolean;
         /**
         * A GraphQL query string parsed into an AST with the gql template literal.
         * 
-        * @docGroup
-        * 
-        * 1. Operation options
+        * @docGroup 1. Operation options
         */
         query: DocumentNode | TypedDocumentNode<TData, TVariables>;
         /**
@@ -118,9 +103,7 @@ export declare namespace ObservableQuery {
         * 
         * Each key in the object corresponds to a variable name, and that key's value corresponds to the variable value.
         * 
-        * @docGroup
-        * 
-        * 1. Operation options
+        * @docGroup 1. Operation options
         */
         variables: TVariables;
     };
@@ -128,9 +111,7 @@ export declare namespace ObservableQuery {
         /**
         * A GraphQL query string parsed into an AST with the gql template literal.
         * 
-        * @docGroup
-        * 
-        * 1. Operation options
+        * @docGroup 1. Operation options
         */
         query?: DocumentNode | TypedDocumentNode<TFetchData, TFetchVars>;
         /**
@@ -138,9 +119,7 @@ export declare namespace ObservableQuery {
         * 
         * Each key in the object corresponds to a variable name, and that key's value corresponds to the variable value.
         * 
-        * @docGroup
-        * 
-        * 1. Operation options
+        * @docGroup 1. Operation options
         */
         variables?: Partial<NoInfer<TFetchVars>>;
         /**
@@ -150,17 +129,13 @@ export declare namespace ObservableQuery {
         * 
         * 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;
         /**
         * 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;
         updateQuery?: (previousQueryResult: Unmasked<TData>, options: {
@@ -200,21 +175,18 @@ export declare namespace ObservableQuery {
     }
     type Result<TData, TStates extends DataState<TData>["dataState"] = DataState<TData>["dataState"]> = {
         /**
-        * 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;
         /**
         * If `true`, the query is still in flight and results have not yet been returned.
         * 
-        * @docGroup
-        * 
-        * 2. Network info
+        * @docGroup 2. Network info
         */
         loading: boolean;
         /**
@@ -222,21 +194,15 @@ export declare namespace ObservableQuery {
         * 
         * Used in conjunction with the [`notifyOnNetworkStatusChange`](#notifyonnetworkstatuschange) option.
         * 
-        * @docGroup
-        * 
-        * 2. Network info
+        * @docGroup 2. Network info
         */
         networkStatus: NetworkStatus;
         /**
-        * Describes whether `data` is a complete or partial result. This flag is only set when `returnPartialData` is `true` in query options.
-        * 
-        * @deprecated
-        * 
-        * This field will be removed in a future version of Apollo Client.
+        * Describes whether `data` is a complete or partial result. This flag is only
+        * set when `returnPartialData` is `true` in query options.
         * 
-        * @docGroup
-        * 
-        * 1. Operation data
+        * @deprecated This field will be removed in a future version of Apollo Client.
+        * @docGroup 1. Operation data
         */
         partial: boolean;
     } & GetDataState<TData, TStates>;
@@ -262,9 +228,8 @@ export declare namespace ObservableQuery {
             /**
             * Used to stitch together functional operators into a chain.
             * 
-            * @returns The Observable result of all the operators having been called in the order they were passed in.
-            * 
             * @example
+            * 
             * ```ts
             * import { filter, map } from 'rxjs';
             * 
@@ -275,13 +240,15 @@ export declare namespace ObservableQuery {
             *   )
             *   .subscribe(x => console.log(x));
             * ```
+            * 
+            * @returns The Observable result of all the operators having been called
+            * in the order they were passed in.
             */
             pipe(...operators: OperatorFunctionChain<ObservableQuery.Result<TData>, OperatorResult>): Observable<OperatorResult>;
             /**
             * Subscribes to the `ObservableQuery`.
-            * 
-            * @param observerOrNext - Either an RxJS `Observer` with some or all callback methods, or the `next` handler that is called for each value emitted from the subscribed Observable.
-            * 
+            * @param observerOrNext - Either an RxJS `Observer` with some or all callback methods,
+            * or the `next` handler that is called for each value emitted from the subscribed Observable.
             * @returns A subscription reference to the registered handlers.
             */
             subscribe(observerOrNext: Partial<Observer<ObservableQuery.Result<MaybeMasked<TData>>>> | ((value: ObservableQuery.Result<MaybeMasked<TData>>) => void)): Subscription;

package/core/QueryInfo.d.ts

@@ -1,6 +1,6 @@
 import type { DocumentNode, FormattedExecutionResult } from "graphql";
 import type { ApolloCache } from "@apollo/client/cache";
-import type { FetchResult } from "@apollo/client/link";
+import type { ApolloLink } from "@apollo/client/link";
 import type { Unmasked } from "@apollo/client/masking";
 import type { ApolloClient } from "./ApolloClient.js";
 import type { ObservableQuery } from "./ObservableQuery.js";
@@ -46,8 +46,8 @@ export declare class QueryInfo<TData, TVariables extends OperationVariables = Op
     private shouldWrite;
     get hasNext(): boolean;
     private maybeHandleIncrementalResult;
-    markQueryResult(incoming: FetchResult<TData>, { document: query, variables, errorPolicy, cacheWriteBehavior, }: OperationInfo<TData, TVariables>): FormattedExecutionResult<DataValue.Complete<TData> | DataValue.Streaming<TData>>;
-    markMutationResult(incoming: FetchResult<TData>, mutation: OperationInfo<TData, TVariables, CacheWriteBehavior.FORBID | CacheWriteBehavior.MERGE> & {
+    markQueryResult(incoming: ApolloLink.Result<TData>, { document: query, variables, errorPolicy, cacheWriteBehavior, }: OperationInfo<TData, TVariables>): FormattedExecutionResult<DataValue.Complete<TData> | DataValue.Streaming<TData>>;
+    markMutationResult(incoming: ApolloLink.Result<TData>, mutation: OperationInfo<TData, TVariables, CacheWriteBehavior.FORBID | CacheWriteBehavior.MERGE> & {
         context?: DefaultContext;
         updateQueries: UpdateQueries<TData>;
         update?: MutationUpdaterFunction<TData, TVariables, TCache>;