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

package/core/ObservableQuery.js

@@ -162,7 +162,32 @@ export class ObservableQuery {
     // We can't use Observable['subscribe'] here as the type as it conflicts with
     // the ability to infer T from Subscribable<T>. This limits the surface area
     // to the non-deprecated signature which works properly with type inference.
+    /**
+     * 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.
+     * @returns A subscription reference to the registered handlers.
+     */
     subscribe;
+    /**
+     * Used to stitch together functional operators into a chain.
+     *
+     * @example
+     *
+     * ```ts
+     * import { filter, map } from 'rxjs';
+     *
+     * observableQuery
+     *   .pipe(
+     *     filter(...),
+     *     map(...),
+     *   )
+     *   .subscribe(x => console.log(x));
+     * ```
+     *
+     * @returns The Observable result of all the operators having been called
+     * in the order they were passed in.
+     */
     pipe;
     [Symbol.observable];
     ["@@observable"];
@@ -318,6 +343,13 @@ export class ObservableQuery {
      * Update the variables of this observable query, and fetch the new results.
      * This method should be preferred over `setVariables` in most use cases.
      *
+     * Returns a `ResultPromise` with an additional `.retain()` method. Calling
+     * `.retain()` keeps the network operation running even if the `ObservableQuery`
+     * no longer requires the result.
+     *
+     * Note: `refetch()` guarantees that a value will be emitted from the
+     * observable, even if the result is deep equal to the previous value.
+     *
      * @param variables - The new set of variables. If there are missing variables,
      * the previous values of those variables will be used.
      */
@@ -353,9 +385,6 @@ export class ObservableQuery {
             newNetworkStatus: NetworkStatus.refetch,
         });
     }
-    /**
-     * 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/).
-     */
     fetchMore({ query, variables, context, errorPolicy, updateQuery, }) {
         invariant(
             this.options.fetchPolicy !== "cache-only",
@@ -560,14 +589,12 @@ export class ObservableQuery {
      * `setVariables` in order to to be properly notified of results even when
      * they come from the cache.
      *
-     * Note: the `next` callback will *not* fire if the variables have not changed
-     * or if the result is coming from cache.
-     *
-     * Note: the promise will return the old results immediately if the variables
-     * have not changed.
+     * Note: `setVariables()` guarantees that a value will be emitted from the
+     * observable, even if the result is deeply equal to the previous value.
      *
-     * Note: the promise will return the last result immediately if the query is not active
-     * (there are no subscribers).
+     * Note: the promise will resolve with the last emitted result
+     * when either the variables match the current variables or there
+     * are no subscribers to the query.
      *
      * @param variables - The new set of variables. If there are missing variables,
      * the previous values of those variables will be used.
@@ -823,6 +850,9 @@ export class ObservableQuery {
     /**
      * Reevaluate the query, optionally against new options. New options will be
      * merged with the current options when given.
+     *
+     * Note: `variables` can be reset back to their defaults (typically empty) by calling `reobserve` with
+     * `variables: undefined`.
      */
     reobserve(newOptions) {
         return this._reobserve(newOptions);