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

documentation for cache.batch? is this fine to use?

Open allusernamestakenexceptthis opened this issue 2 months ago • 4 comments

we found cache.batch and it works well performance wise

BUT, there is no official documentation anywhere.

and I found this documentation attempt issue closed: https://github.com/apollographql/apollo-client/pull/9987

  • is this fine to use?
  • any ETA on documentation?

Thanks

It's a public API without an @internal or @deprecated marker, so it's fine to use!

You're right that we need documentation here - I can't give you an ETA on it right now, but we'll try to add it soon. Otherwise, docs contributions are welcome!

phryneas avatar Oct 30 '25 10:10 phryneas

@phryneas if no one is working on this yet, I can take care of documenting it :)

bas0N avatar Dec 01 '25 22:12 bas0N

@bas0N go for it! If you decide to work on this, can you make sure to add a doc block to the method itself?

https://github.com/apollographql/apollo-client/blob/0a09828c4a321192a3fc8b1225e927b33ad3c45a/src/cache/core/cache.ts#L188

Thanks!

jerelmiller avatar Dec 01 '25 23:12 jerelmiller

PR #13048 adds the cache.batch docs. Ready for review when you have a chance!

bas0N avatar Dec 12 '25 00:12 bas0N

Do you have any feedback for the maintainers? Please tell us by taking a one-minute survey. Your responses will help us understand Apollo Client usage and allow us to serve you better.

github-actions[bot] avatar Dec 18 '25 18:12 github-actions[bot]