{Public,Private}RefetchQueriesOptions => {,Internal}RefetchQueriesOpt…

…ions #8000 (comment)
apollographql · Apr 20, 2021 · b19a89f · b19a89f
1 parent 6dd5f81
commit b19a89f
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/src/core/ApolloClient.ts b/src/core/ApolloClient.ts
@@ -23,7 +23,7 @@ import {
   MutationOptions,
   SubscriptionOptions,
   WatchQueryFetchPolicy,
-  PublicRefetchQueriesOptions,
+  RefetchQueriesOptions,
 } from './watchQueryOptions';
 
 import {
@@ -539,7 +539,7 @@ export class ApolloClient<TCacheShape> implements DataProxy {
     TData,
     TCache extends ApolloCache<any> = ApolloCache<TCacheShape>,
   >(
-    options: PublicRefetchQueriesOptions<TData, TCache>,
+    options: RefetchQueriesOptions<TData, TCache>,
   ): {
     queries: ObservableQuery<any>[];
     updates: any[];

diff --git a/src/core/QueryManager.ts b/src/core/QueryManager.ts
@@ -29,7 +29,7 @@ import {
   WatchQueryFetchPolicy,
   ErrorPolicy,
   RefetchQueryDescription,
-  PrivateRefetchQueriesOptions,
+  InternalRefetchQueriesOptions,
 } from './watchQueryOptions';
 import { ObservableQuery } from './ObservableQuery';
 import { NetworkStatus, isNetworkRequestInFlight } from './networkStatus';
@@ -1041,7 +1041,7 @@ export class QueryManager<TStore> {
     optimistic = false,
     removeOptimistic = optimistic ? makeUniqueId("refetchQueries") : void 0,
     onQueryUpdated,
-  }: PrivateRefetchQueriesOptions<TData, ApolloCache<TStore>>) {
+  }: InternalRefetchQueriesOptions<TData, ApolloCache<TStore>>) {
     const includedQueriesById = new Map<string, RefetchQueryDescription[number]>();
     const results = new Map<ObservableQuery<any>, any>();
 

diff --git a/src/core/watchQueryOptions.ts b/src/core/watchQueryOptions.ts
@@ -184,7 +184,9 @@ export interface SubscriptionOptions<TVariables = OperationVariables, TData = an
 
 export type RefetchQueryDescription = Array<string | PureQueryOptions>;
 
-export interface PublicRefetchQueriesOptions<
+// Used by ApolloClient["refetchQueries"]
+// TODO Improve documentation comments for this public type.
+export interface RefetchQueriesOptions<
   TData,
   TCache extends ApolloCache<any>,
 > {
@@ -198,10 +200,11 @@ export interface PublicRefetchQueriesOptions<
   onQueryUpdated?: OnQueryUpdated<TData>;
 }
 
-export interface PrivateRefetchQueriesOptions<
+// Used by QueryManager["refetchQueries"]
+export interface InternalRefetchQueriesOptions<
   TData,
   TCache extends ApolloCache<any>,
-> extends Omit<PublicRefetchQueriesOptions<TData, TCache>, "include"> {
+> extends Omit<RefetchQueriesOptions<TData, TCache>, "include"> {
   // Just like the refetchQueries array for a mutation, allowing both strings
   // and PureQueryOptions objects.
   include?: RefetchQueryDescription;