Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create separate BackgroundQueryHookOptions type and use it for useBackgroundQuery #11018

Merged
merged 3 commits into from
Jun 28, 2023

Conversation

jerelmiller
Copy link
Member

It's very likely the APIs and options provided to useBackgroundQuery and useSuspenseQuery will grow and diverge over time. Currently, the useBackgroundQuery hook uses the same options type that useSuspenseQuery does, which makes it less flexible to grow over time.

This PR introduces a new BackgroundQueryHookOptions type that is used for useBackgroundQuery to ensure the options types can grow independently of each other.

NOTE: #10960 will need to update this new type to include returnPartialData and refetchWritePolicy, depending on which PR is merged first.

Checklist:

  • If this PR contains changes to the library itself (not necessary for e.g. docs updates), please include a changeset (see CONTRIBUTING.md)
  • If this PR is a new feature, please reference an issue where a consensus about the design was reached (not necessary for small changes)
  • Make sure all of the significant new logic is covered by tests

@changeset-bot
Copy link

changeset-bot bot commented Jun 27, 2023

🦋 Changeset detected

Latest commit: d39bfce

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@apollo/client Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@github-actions
Copy link
Contributor

github-actions bot commented Jun 27, 2023

size-limit report 📦

Path Size
dist/apollo-client.min.cjs 36.85 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/main.cjs" 43.38 KB (0%)
import { ApolloClient, InMemoryCache, HttpLink } from "dist/index.js" 32.56 KB (0%)
import { ApolloProvider } from "dist/react/index.js" 1.3 KB (0%)
import { useQuery } from "dist/react/index.js" 4.33 KB (0%)
import { useLazyQuery } from "dist/react/index.js" 4.65 KB (0%)
import { useMutation } from "dist/react/index.js" 2.56 KB (0%)
import { useSubscription } from "dist/react/index.js" 2.31 KB (0%)
import { useSuspenseQuery } from "dist/react/index.js" 3.71 KB (0%)
import { useBackgroundQuery } from "dist/react/index.js" 3.78 KB (0%)
import { useReadQuery } from "dist/react/index.js" 2.48 KB (0%)
import { useFragment } from "dist/react/index.js" 2.12 KB (0%)

Copy link
Member

@alessbell alessbell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😎

@jerelmiller jerelmiller merged commit 5618953 into release-3.8 Jun 28, 2023
@jerelmiller jerelmiller deleted the jerel/minor-background-query-tweaks branch June 28, 2023 04:16
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 29, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants