add firstChunk property on client.query result, add client.waitForFragment

[phryneas]

We will not back-land this in v3, we just open this PR to get feedback from a user who is still in the process of migrating to v4

This adds a firstChunk property on the client.query result promise and also adds a client.waitForFragment function.

Instead of

const result = await client.query({
  query,
});

which will wait until all deferred chunks have been resolved, this adds the ability to do

const firstChunkResult = await client.query({
  query,
}).firstChunk;

instead, which will resolve once initial incremental result comes in, even while deferred chunks are still pending.

Then, further down in the tree, deferred fragments can be consumed like

const fragmentData = await client.waitForFragment({
  fragment: HelloFragment,
  from: firstChunkResult.data.hello,
});

[changeset-bot]

⚠️ No Changeset found

Latest commit: be85aba

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

[apollo-librarian]

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

15 new, 63 changed, 26 removed

+ (developer-tools)/react/(latest)/api/errors/CombinedGraphQLErrors.mdx
+ (developer-tools)/react/(latest)/api/errors/CombinedProtocolErrors.mdx
+ (developer-tools)/react/(latest)/api/errors/LinkError.mdx
+ (developer-tools)/react/(latest)/api/errors/LocalStateError.mdx
+ (developer-tools)/react/(latest)/api/errors/ServerError.mdx
+ (developer-tools)/react/(latest)/api/errors/ServerParseError.mdx
+ (developer-tools)/react/(latest)/api/errors/UnconventionalError.mdx
+ (developer-tools)/react/(latest)/api/link/apollo-link-rest.mdx
+ (developer-tools)/react/(latest)/api/link/persisted-queries.mdx
+ (developer-tools)/react/(latest)/api/react/components.mdx
+ (developer-tools)/react/(latest)/api/react/hoc.mdx
+ (developer-tools)/react/(latest)/development-testing/static-typing.mdx
+ (developer-tools)/react/(latest)/local-state/client-side-schema.mdx
+ (developer-tools)/react/(latest)/migrating/apollo-client-3-migration.mdx
+ (developer-tools)/react/(latest)/migrating/hooks-migration.mdx
* (developer-tools)/react/(latest)/get-started.mdx
* (developer-tools)/react/(latest)/index.mdx
* (developer-tools)/react/(latest)/why-apollo.mdx
* (developer-tools)/react/(latest)/api/cache/InMemoryCache.mdx
* (developer-tools)/react/(latest)/api/core/ApolloClient.mdx
* (developer-tools)/react/(latest)/api/core/ObservableQuery.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-batch-http.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-context.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-error.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-http.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-remove-typename.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-retry.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-schema.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-subscriptions.mdx
* (developer-tools)/react/(latest)/api/link/apollo-link-ws.mdx
* (developer-tools)/react/(latest)/api/link/community-links.mdx
* (developer-tools)/react/(latest)/api/link/introduction.mdx
* (developer-tools)/react/(latest)/api/react/hooks.mdx
* (developer-tools)/react/(latest)/api/react/preloading.mdx
* (developer-tools)/react/(latest)/api/react/ssr.mdx
* (developer-tools)/react/(latest)/api/react/testing.mdx
* (developer-tools)/react/(latest)/caching/advanced-topics.mdx
* (developer-tools)/react/(latest)/caching/cache-configuration.mdx
* (developer-tools)/react/(latest)/caching/cache-field-behavior.mdx
* (developer-tools)/react/(latest)/caching/cache-interaction.mdx
* (developer-tools)/react/(latest)/caching/garbage-collection.mdx
* (developer-tools)/react/(latest)/caching/memory-management.mdx
* (developer-tools)/react/(latest)/caching/overview.mdx
* (developer-tools)/react/(latest)/data/defer.mdx
* (developer-tools)/react/(latest)/data/directives.mdx
* (developer-tools)/react/(latest)/data/document-transforms.mdx
* (developer-tools)/react/(latest)/data/error-handling.mdx
* (developer-tools)/react/(latest)/data/file-uploads.mdx
* (developer-tools)/react/(latest)/data/fragments.mdx
* (developer-tools)/react/(latest)/data/mutations.mdx
* (developer-tools)/react/(latest)/data/operation-best-practices.mdx
* (developer-tools)/react/(latest)/data/queries.mdx
* (developer-tools)/react/(latest)/data/refetching.mdx
* (developer-tools)/react/(latest)/data/subscriptions.mdx
* (developer-tools)/react/(latest)/data/suspense.mdx
* (developer-tools)/react/(latest)/development-testing/client-schema-mocking.mdx
* (developer-tools)/react/(latest)/development-testing/developer-tooling.mdx
* (developer-tools)/react/(latest)/development-testing/schema-driven-testing.mdx
* (developer-tools)/react/(latest)/development-testing/testing.mdx
* (developer-tools)/react/(latest)/integrations/integrations.mdx
* (developer-tools)/react/(latest)/integrations/react-native.mdx
* (developer-tools)/react/(latest)/integrations/webpack.mdx
* (developer-tools)/react/(latest)/local-state/local-resolvers.mdx
* (developer-tools)/react/(latest)/local-state/local-state-management.mdx
* (developer-tools)/react/(latest)/local-state/managing-state-with-field-policies.mdx
* (developer-tools)/react/(latest)/local-state/reactive-variables.mdx
* (developer-tools)/react/(latest)/networking/advanced-http-networking.mdx
* (developer-tools)/react/(latest)/networking/authentication.mdx
* (developer-tools)/react/(latest)/networking/basic-http-networking.mdx
* (developer-tools)/react/(latest)/pagination/core-api.mdx
* (developer-tools)/react/(latest)/pagination/cursor-based.mdx
* (developer-tools)/react/(latest)/pagination/key-args.mdx
* (developer-tools)/react/(latest)/pagination/offset-based.mdx
* (developer-tools)/react/(latest)/performance/babel.mdx
* (developer-tools)/react/(latest)/performance/optimistic-ui.mdx
* (developer-tools)/react/(latest)/performance/performance.mdx
* (developer-tools)/react/(latest)/performance/server-side-rendering.mdx
* (developer-tools)/react/(latest)/_sidebar.yaml
- (developer-tools)/react/(latest)/api/link/apollo-link-base-batch-http.mdx
- (developer-tools)/react/(latest)/api/link/apollo-link-base-http.mdx
- (developer-tools)/react/(latest)/api/link/apollo-link-batch.mdx
- (developer-tools)/react/(latest)/api/link/apollo-link-client-awareness.mdx
- (developer-tools)/react/(latest)/api/link/apollo-link-persisted-queries.mdx
- (developer-tools)/react/(latest)/api/link/apollo-link.mdx
- (developer-tools)/react/(latest)/api/react/ApolloProvider.mdx
- (developer-tools)/react/(latest)/api/react/skipToken.mdx
- (developer-tools)/react/(latest)/api/react/useApolloClient.mdx
- (developer-tools)/react/(latest)/api/react/useBackgroundQuery.mdx
- (developer-tools)/react/(latest)/api/react/useFragment.mdx
- (developer-tools)/react/(latest)/api/react/useLazyQuery.mdx
- (developer-tools)/react/(latest)/api/react/useLoadableQuery.mdx
- (developer-tools)/react/(latest)/api/react/useMutation.mdx
- (developer-tools)/react/(latest)/api/react/useQuery.mdx
- (developer-tools)/react/(latest)/api/react/useQueryRefHandlers.mdx
- (developer-tools)/react/(latest)/api/react/useReactiveVar.mdx
- (developer-tools)/react/(latest)/api/react/useReadQuery.mdx
- (developer-tools)/react/(latest)/api/react/useSubscription.mdx
- (developer-tools)/react/(latest)/api/react/useSuspenseQuery.mdx
- (developer-tools)/react/(latest)/data/persisted-queries.mdx
- (developer-tools)/react/(latest)/data/typescript.mdx
- (developer-tools)/react/(latest)/development-testing/graphql-codegen.mdx
- (developer-tools)/react/(latest)/migrating/apollo-client-4-migration.mdx
- (developer-tools)/react/(latest)/VERSIONING_POLICY.md
- (developer-tools)/react/(latest)/versioning-policy.md

Build ID: aa36a5a024e33e6c64e1bcdc
Build Logs: View logs

URL: https://www.apollographql.com/docs/deploy-preview/aa36a5a024e33e6c64e1bcdc

[pkg-pr-new]

npm i https://pkg.pr.new/@apollo/client@12953

commit: be85aba