From c4e2a1497393b8672a17f8c7aa2c0556971dcb04 Mon Sep 17 00:00:00 2001 From: Luca Pizzini Date: Fri, 31 Mar 2023 17:28:37 +0200 Subject: [PATCH] docs(ApolloClient): added documentation for getObservableQueries method (#10669) Co-authored-by: Jerel Miller Co-authored-by: Alessia Bellisario --- docs/source/api/core/ApolloClient.mdx | 1 + src/core/ApolloClient.ts | 13 ++++++++----- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/source/api/core/ApolloClient.mdx b/docs/source/api/core/ApolloClient.mdx index 9776f43f45c..d4a0467c424 100644 --- 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. + ## Types diff --git a/src/core/ApolloClient.ts b/src/core/ApolloClient.ts index e0a8e9d6e16..3bf907d317a 100644 --- a/src/core/ApolloClient.ts +++ b/src/core/ApolloClient.ts @@ -575,11 +575,14 @@ export class ApolloClient 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",