Rename useObservableQuery to useBackgroundQuery.

apollographql · Dec 10, 2021 · dce43ed · dce43ed
1 parent d7cd7eb
commit dce43ed
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 16 deletions.
diff --git a/src/__tests__/__snapshots__/exports.ts.snap b/src/__tests__/__snapshots__/exports.ts.snap
@@ -54,10 +54,10 @@ Array [
   "throwServerError",
   "toPromise",
   "useApolloClient",
+  "useBackgroundQuery",
   "useFragment",
   "useLazyQuery",
   "useMutation",
-  "useObservableQuery",
   "useQuery",
   "useReactiveVar",
   "useSubscription",
@@ -240,10 +240,10 @@ Array [
   "parser",
   "resetApolloContext",
   "useApolloClient",
+  "useBackgroundQuery",
   "useFragment",
   "useLazyQuery",
   "useMutation",
-  "useObservableQuery",
   "useQuery",
   "useReactiveVar",
   "useSubscription",
@@ -280,10 +280,10 @@ Array [
 exports[`exports of public entry points @apollo/client/react/hooks 1`] = `
 Array [
   "useApolloClient",
+  "useBackgroundQuery",
   "useFragment",
   "useLazyQuery",
   "useMutation",
-  "useObservableQuery",
   "useQuery",
   "useReactiveVar",
   "useSubscription",

diff --git a/...pshots__/useObservableQuery.test.tsx.snap → ...pshots__/useBackgroundQuery.test.tsx.snap b/...pshots__/useObservableQuery.test.tsx.snap → ...pshots__/useBackgroundQuery.test.tsx.snap
@@ -1,6 +1,6 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`useObservableQuery useObservableQuery avoids depending on whole query response 1`] = `
+exports[`useBackgroundQuery useBackgroundQuery avoids depending on whole query response 1`] = `
 Object {
   "Item:1": Object {
     "__typename": "Item",

diff --git a/...oks/__tests__/useObservableQuery.test.tsx → ...oks/__tests__/useBackgroundQuery.test.tsx b/...oks/__tests__/useObservableQuery.test.tsx → ...oks/__tests__/useBackgroundQuery.test.tsx
@@ -4,7 +4,7 @@ import { act } from "react-dom/test-utils";
 import { Subscription } from "zen-observable-ts";
 
 import { useFragment } from "../useFragment";
-import { useObservableQuery } from "../useObservableQuery";
+import { useBackgroundQuery } from "../useBackgroundQuery";
 import { itAsync, MockedProvider } from "../../../testing";
 import { ApolloProvider } from "../../context";
 import {
@@ -19,7 +19,7 @@ import {
   NetworkStatus,
 } from "../../../core";
 
-describe("useObservableQuery", () => {
+describe("useBackgroundQuery", () => {
   itAsync("can be used as a replacement for useQuery", (resolve, reject) => {
     type TData = {
       words: string[];
@@ -42,7 +42,7 @@ describe("useObservableQuery", () => {
         useNetworkStatus,
         useData,
         useError,
-      } = useObservableQuery({
+      } = useBackgroundQuery({
         query,
         notifyOnNetworkStatusChange: true,
       });
@@ -175,7 +175,7 @@ describe("useObservableQuery", () => {
     list: Item[];
   };
 
-  itAsync("useObservableQuery avoids depending on whole query response", async (resolve, reject) => {
+  itAsync("useBackgroundQuery avoids depending on whole query response", async (resolve, reject) => {
     const cache = new InMemoryCache({
       typePolicies: {
         Item: {
@@ -236,7 +236,7 @@ describe("useObservableQuery", () => {
         useNetworkStatus,
         useError,
         useData,
-      } = useObservableQuery({
+      } = useBackgroundQuery({
         query: listQuery,
       });
 
@@ -261,7 +261,7 @@ describe("useObservableQuery", () => {
 
       // Test that we can force a specific ObservableQuery by passing it instead
       // of WatchQueryOptions.
-      expect(useObservableQuery(observable).observable).toBe(observable);
+      expect(useBackgroundQuery(observable).observable).toBe(observable);
 
       return complete ? (
         <ol>

diff --git a/src/react/hooks/index.ts b/src/react/hooks/index.ts
@@ -7,4 +7,4 @@ export * from './useQuery';
 export * from './useSubscription';
 export * from './useReactiveVar';
 export * from './useFragment';
-export * from './useObservableQuery';
+export * from './useBackgroundQuery';
diff --git a/src/react/hooks/useObservableQuery.ts → src/react/hooks/useBackgroundQuery.ts b/src/react/hooks/useObservableQuery.ts → src/react/hooks/useBackgroundQuery.ts
@@ -15,11 +15,11 @@ import {
 import { useApolloClient } from "./useApolloClient";
 import { useReactiveVar } from "./useReactiveVar";
 
-export function useObservableQuery<TData, TVars>(
+export function useBackgroundQuery<TData, TVars>(
   queryOrOptions:
     | ObservableQuery<TData, TVars>
     | WatchQueryOptions<TVars, TData>,
-): UseObservableQueryResult<TData, TVars> {
+): UseBackgroundQueryResult<TData, TVars> {
   const state = useInternalState(queryOrOptions);
   const { observable } = state;
 
@@ -62,10 +62,10 @@ export function useObservableQuery<TData, TVars>(
   return state;
 }
 
-export interface UseObservableQueryResult<TData, TVars> {
+export interface UseBackgroundQueryResult<TData, TVars> {
   observable: ObservableQuery<TData, TVars>;
   // By returning hook functions that the component can choose to call (or not),
-  // useObservableQuery is technically a "higher-order hook," in the same way a
+  // useBackgroundQuery is technically a "higher-order hook," in the same way a
   // function that returns other functions is a higher-order function.
   useLoading(): boolean;
   useNetworkStatus(): NetworkStatus;
@@ -74,7 +74,7 @@ export interface UseObservableQueryResult<TData, TVars> {
 }
 
 interface InternalState<TData, TVars>
-extends UseObservableQueryResult<TData, TVars> {
+extends UseBackgroundQueryResult<TData, TVars> {
   options: WatchQueryOptions<TVars, TData>;
   loadingVar: ReactiveVar<boolean>;
   networkStatusVar: ReactiveVar<NetworkStatus>;