apollo-client icon indicating copy to clipboard operation
apollo-client copied to clipboard

docs: add documentation for cache.batch method (#12990)

Open bas0N opened this issue 1 month ago • 2 comments

docs: add documentation for cache.batch method

Fixes #12990

Adds comprehensive documentation for the cache.batch method:

  • JSDoc (src/cache/core/cache.ts) - Added doc block with description, examples, and parameter docs
  • Guide (docs/source/caching/cache-interaction.mdx) - New section covering usage, optimistic updates, and onWatchUpdated
  • API Reference (docs/source/api/cache/InMemoryCache.mdx) - Full API docs with options table and signature

bas0N avatar Dec 12 '25 00:12 bas0N

@bas0N: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/

apollo-cla avatar Dec 12 '25 00:12 apollo-cla

⚠️ No Changeset found

Latest commit: d91eab0072036ecdc66a1360f26dec9a9f22e3bd

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

changeset-bot[bot] avatar Dec 12 '25 00:12 changeset-bot[bot]

npm i https://pkg.pr.new/apollographql/apollo-client/@apollo/client@13048

commit: 51cbcff

pkg-pr-new[bot] avatar Dec 18 '25 17:12 pkg-pr-new[bot]

Thank you for the contribution, let's get this into the docs! 🎉

phryneas avatar Dec 18 '25 18:12 phryneas