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

package/__cjs/core/ApolloClient.d.cts

@@ -2,7 +2,7 @@ import type { DocumentNode } from "graphql";
 import type { Observable } from "rxjs";
 import type { ApolloCache, IgnoreModifier, Reference } from "@apollo/client/cache";
 import type { Incremental } from "@apollo/client/incremental";
-import type { ApolloLink, FetchResult, GraphQLRequest } from "@apollo/client/link";
+import type { ApolloLink } from "@apollo/client/link";
 import type { ClientAwarenessLink } from "@apollo/client/link/client-awareness";
 import type { LocalState } from "@apollo/client/local-state";
 import type { MaybeMasked, Unmasked } from "@apollo/client/masking";
@@ -62,11 +62,11 @@ export declare namespace ApolloClient {
         assumeImmutableResults?: boolean;
         localState?: LocalState;
         /**
-        *  
+        * 
         */
         clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;
         /**
-        *  
+        * 
         */
         enhancedClientAwareness?: ClientAwarenessLink.EnhancedClientAwarenessOptions;
         documentTransform?: DocumentTransform;
@@ -104,19 +104,24 @@ export declare namespace ApolloClient {
     }
     type MutateOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables, TCache extends ApolloCache = ApolloCache> = {
         /**
-        * By providing either an object or a callback function that, when invoked after a mutation, allows you to return optimistic data and optionally skip updates via the `IGNORE` sentinel object, Apollo Client caches this temporary (and potentially incorrect) response until the mutation completes, enabling more responsive UI updates.
+        * By providing either an object or a callback function that, when invoked after
+        * a mutation, allows you to return optimistic data and optionally skip updates
+        * via the `IGNORE` sentinel object, Apollo Client caches this temporary
+        * (and potentially incorrect) response until the mutation completes, enabling
+        * more responsive UI updates.
         * 
         * For more information, see [Optimistic mutation results](https://www.apollographql.com/docs/react/performance/optimistic-ui/).
         * 
-        * @docGroup
-        * 
-        * 3. Caching options
+        * @docGroup 3. Caching options
         */
         optimisticResponse?: Unmasked<NoInfer<TData>> | ((vars: TVariables, { IGNORE }: {
             IGNORE: IgnoreModifier;
         }) => Unmasked<NoInfer<TData>> | IgnoreModifier);
         /**
-        * A `MutationQueryReducersMap`, which is map from query names to mutation query reducers. Briefly, this map defines how to incorporate the results of the mutation into the results of queries that are currently being watched by your application.
+        * A `MutationQueryReducersMap`, which is map from query names to
+        * mutation query reducers. Briefly, this map defines how to incorporate the
+        * results of the mutation into the results of queries that are currently
+        * being watched by your application.
         */
         updateQueries?: MutationQueryReducersMap<TData>;
         /**
@@ -128,9 +133,7 @@ export declare namespace ApolloClient {
         * 
         * - A string indicating the operation name of the query to refetch
         * 
-        * @docGroup
-        * 
-        * 1. Operation options
+        * @docGroup 1. Operation options
         */
         refetchQueries?: ((result: NormalizedExecutionResult<Unmasked<TData>>) => InternalRefetchQueriesInclude) | InternalRefetchQueriesInclude;
         /**
@@ -138,9 +141,7 @@ export declare namespace ApolloClient {
         * 
         * The default value is `false` (queries are refetched asynchronously).
         * 
-        * @docGroup
-        * 
-        * 1. Operation options
+        * @docGroup 1. Operation options
         */
         awaitRefetchQueries?: boolean;
         /**
@@ -148,9 +149,7 @@ export declare namespace ApolloClient {
         * 
         * For more information, see [Updating the cache after a mutation](https://www.apollographql.com/docs/react/data/mutations#updating-the-cache-after-a-mutation).
         * 
-        * @docGroup
-        * 
-        * 3. Caching options
+        * @docGroup 3. Caching options
         */
         update?: MutationUpdaterFunction<TData, TVariables, TCache>;
         /**
@@ -158,9 +157,7 @@ export declare namespace ApolloClient {
         * 
         * Returning a `Promise` from `onQueryUpdated` will cause the final mutation `Promise` to await the returned `Promise`. Returning `false` causes the query to be ignored.
         * 
-        * @docGroup
-        * 
-        * 1. Operation options
+        * @docGroup 1. Operation options
         */
         onQueryUpdated?: OnQueryUpdated<any>;
         /**
@@ -170,17 +167,13 @@ export declare namespace ApolloClient {
         * 
         * The default value is `none`, meaning that the mutation 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;
         /**
@@ -190,21 +183,24 @@ export declare namespace ApolloClient {
         * 
         * Unlike queries, mutations _do not_ support [fetch policies](https://www.apollographql.com/docs/react/data/queries/#setting-a-fetch-policy) besides `network-only` and `no-cache`.
         * 
-        * @docGroup
-        * 
-        * 3. Caching options
+        * @docGroup 3. Caching options
         */
         fetchPolicy?: MutationFetchPolicy;
         /**
-        * To avoid retaining sensitive information from mutation root field arguments, Apollo Client v3.4+ automatically clears any `ROOT_MUTATION` fields from the cache after each mutation finishes. If you need this information to remain in the cache, you can prevent the removal by passing `keepRootFields: true` to the mutation. `ROOT_MUTATION` result data are also passed to the mutation `update` function, so we recommend obtaining the results that way, rather than using this option, if possible.
+        * To avoid retaining sensitive information from mutation root field
+        * arguments, Apollo Client v3.4+ automatically clears any `ROOT_MUTATION`
+        * fields from the cache after each mutation finishes. If you need this
+        * information to remain in the cache, you can prevent the removal by passing
+        * `keepRootFields: true` to the mutation. `ROOT_MUTATION` result data are
+        * also passed to the mutation `update` function, so we recommend obtaining
+        * the results that way, rather than using this option, if possible.
         */
         keepRootFields?: boolean;
         /**
-        * A GraphQL document, often created with `gql` from the `graphql-tag` package, that contains a single mutation inside of it.
+        * A GraphQL document, often created with `gql` from the `graphql-tag`
+        * package, that contains a single mutation inside of it.
         * 
-        * @docGroup
-        * 
-        * 1. Operation options
+        * @docGroup 1. Operation options
         */
         mutation: DocumentNode | TypedDocumentNode<TData, TVariables>;
     } & VariablesOption<NoInfer<TVariables>>;
@@ -231,9 +227,7 @@ export declare namespace ApolloClient {
         /**
         * 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>;
         /**
@@ -243,17 +237,13 @@ export declare namespace ApolloClient {
         * 
         * 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;
         /**
@@ -263,9 +253,7 @@ export declare namespace ApolloClient {
         * 
         * The default value is `cache-first`.
         * 
-        * @docGroup
-        * 
-        * 3. Caching options
+        * @docGroup 3. Caching options
         */
         fetchPolicy?: FetchPolicy;
     } & VariablesOption<NoInfer<TVariables>>;
@@ -275,19 +263,16 @@ export declare namespace ApolloClient {
         * 
         * This value might be `undefined` if a query results in one or more errors (depending on the query's `errorPolicy`).
         * 
-        * @docGroup
-        * 
-        * 1. Operation data
+        * @docGroup 1. Operation data
         */
         data: TData | undefined;
         /**
-        * 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;
     }
@@ -349,7 +334,8 @@ export declare namespace ApolloClient {
     }
     type SubscribeOptions<TData = unknown, TVariables extends OperationVariables = OperationVariables> = {
         /**
-        * A GraphQL document, often created with `gql` from the `graphql-tag` package, that contains a single subscription inside of it.
+        * A GraphQL document, often created with `gql` from the `graphql-tag`
+        * package, that contains a single subscription inside of it.
         */
         query: DocumentNode | TypedDocumentNode<TData, TVariables>;
         /**
@@ -398,33 +384,30 @@ export declare namespace ApolloClient {
         * 
         * 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: 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;
         /**
@@ -434,17 +417,13 @@ export declare namespace ApolloClient {
         * 
         * 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;
         /**
@@ -452,9 +431,7 @@ export declare namespace ApolloClient {
         * 
         * The default value is `0` (no polling).
         * 
-        * @docGroup
-        * 
-        * 2. Networking options
+        * @docGroup 2. Networking options
         */
         pollInterval?: number;
         /**
@@ -462,9 +439,7 @@ export declare namespace ApolloClient {
         * 
         * The default value is `true`.
         * 
-        * @docGroup
-        * 
-        * 2. Networking options
+        * @docGroup 2. Networking options
         */
         notifyOnNetworkStatusChange?: boolean;
         /**
@@ -472,25 +447,21 @@ export declare namespace ApolloClient {
         * 
         * 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.
-        * 
-        * @docGroup
+        * 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.
         * 
-        * 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>;
     } & VariablesOption<NoInfer<TVariables>>;
@@ -802,10 +773,14 @@ export declare class ApolloClient {
      */
     readQuery<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadQueryOptions<TData, TVariables>): Unmasked<TData> | null;
     /**
-    * Tries to read some data from the store in the shape of the provided GraphQL query without making a network request. This method will start at the root query. To start at a specific id returned by `cache.identify` use `readFragment`.
-    * 
-    * @param optimistic - Set to `true` to allow `readQuery` to return optimistic results. Is `false` by default.
+    * Tries to read some data from the store in the shape of the provided
+    * GraphQL query without making a network request. This method will start at
+    * the root query. To start at a specific id returned by `cache.identify`
+    * use `readFragment`.
     * 
+    * @param optimistic - Set to `true` to allow `readQuery` to return
+    * optimistic results. Is `false` by default.
+    *      
     *
     * @deprecated Pass the `optimistic` argument as part of the first argument
     * instead of passing it as a separate option.
@@ -849,12 +824,19 @@ export declare class ApolloClient {
      */
     readFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.ReadFragmentOptions<TData, TVariables>): Unmasked<TData> | null;
     /**
-    * Tries to read some data from the store in the shape of the provided GraphQL fragment without making a network request. This method will read a GraphQL fragment from any arbitrary id that is currently cached, unlike `readQuery` which will only read from the root query.
-    * 
-    * You must pass in a GraphQL document with a single fragment or a document with multiple fragments that represent what you are reading. If you pass in a document with multiple fragments then you must also specify a `fragmentName`.
+    * Tries to read some data from the store in the shape of the provided
+    * GraphQL fragment without making a network request. This method will read a
+    * GraphQL fragment from any arbitrary id that is currently cached, unlike
+    * `readQuery` which will only read from the root query.
     * 
-    * @param optimistic - Set to `true` to allow `readFragment` to return optimistic results. Is `false` by default.
+    * You must pass in a GraphQL document with a single fragment or a document
+    * with multiple fragments that represent what you are reading. If you pass
+    * in a document with multiple fragments then you must also specify a
+    * `fragmentName`.
     * 
+    * @param optimistic - Set to `true` to allow `readFragment` to return
+    * optimistic results. Is `false` by default.
+    *      
     *
     * @deprecated Pass the `optimistic` argument as part of the first argument
     * instead of passing it as a separate option.
@@ -879,7 +861,7 @@ export declare class ApolloClient {
      */
     writeFragment<TData = unknown, TVariables extends OperationVariables = OperationVariables>(options: ApolloClient.WriteFragmentOptions<TData, TVariables>): Reference | undefined;
     __actionHookForDevTools(cb: () => any): void;
-    __requestRaw(payload: GraphQLRequest): Observable<FetchResult<unknown>>;
+    __requestRaw(request: ApolloLink.Request): Observable<ApolloLink.Result<unknown>>;
     /**
      * Resets your entire store by clearing out your cache and then re-executing
      * all of your active queries. This makes it so that you may guarantee that

package/__cjs/core/ObservableQuery.d.cts

@@ -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;