docs(ApolloClient): added documentation for getObservableQueries meth…

…od (#10669) Co-authored-by: Jerel Miller <jerelmiller@gmail.com> Co-authored-by: Alessia Bellisario <alessia@apollographql.com>
apollographql · Mar 31, 2023 · c4e2a14 · c4e2a14
1 parent 152baac
commit c4e2a14
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 5 deletions.
diff --git a/docs/source/api/core/ApolloClient.mdx b/docs/source/api/core/ApolloClient.mdx
@@ -266,6 +266,7 @@ different value for the same option in individual function calls.
 <TypescriptApiBox name="ApolloClient.stop" />
 <TypescriptApiBox name="ApolloClient.reFetchObservableQueries" />
 <TypescriptApiBox name="ApolloClient.refetchQueries" />
+<TypescriptApiBox name="ApolloClient.getObservableQueries" />
 
 ## Types
 

diff --git a/src/core/ApolloClient.ts b/src/core/ApolloClient.ts
@@ -575,11 +575,14 @@ export class ApolloClient<TCacheShape> implements DataProxy {
 
   /**
    * Get all currently active `ObservableQuery` objects, in a `Map` keyed by
-   * query ID strings. An "active" query is one that has observers and a
-   * `fetchPolicy` other than "standby" or "cache-only". You can include all
-   * `ObservableQuery` objects (including the inactive ones) by passing "all"
-   * instead of "active", or you can include just a subset of active queries by
-   * passing an array of query names or DocumentNode objects.
+   * query ID strings.
+   *
+   * An "active" query is one that has observers and a `fetchPolicy` other than
+   * "standby" or "cache-only".
+   *
+   * You can include all `ObservableQuery` objects (including the inactive ones)
+   * by passing "all" instead of "active", or you can include just a subset of
+   * active queries by passing an array of query names or DocumentNode objects.
    */
   public getObservableQueries(
     include: RefetchQueriesInclude = "active",