docs(persister): document asynchronous serialization callbacks - #11411
docs(persister): document asynchronous serialization callbacks#11411grzdev wants to merge 1 commit into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughThe async storage persister documentation updates ChangesAsync persister documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Merge Risk: ⚪ Minimal · up to This documentation update accurately describes existing synchronous and Promise-based serialization support, with no runtime or release behavior changed. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
🎯 Changes
The
createAsyncStoragePersisteroptions documentation currently listsserializeanddeserializeas synchronous functions returningstringandPersistedClient.In the implementation (
packages/query-async-storage-persister/src/index.ts), both options accept and awaitMaybePromise<string>andMaybePromise<PersistedClient>. This update aligns the documented TypeScript interface signatures and adds a note explaining that both callbacks support synchronous and asynchronous (Promise) returns.Documentation only. Verified against
createAsyncStoragePersisterimplementation and types;git diff --checkpasses cleanly.✅ Checklist
pnpm run test:pr, or these tests do not apply to this pull request.🚀 Release Impact
Summary by CodeRabbit