-
Notifications
You must be signed in to change notification settings - Fork 12
[INJIVER-1512] update readme #146
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
[INJIVER-1512] update readme #146
Conversation
Signed-off-by: srikanth716 <srikanthsri7447@gmail.com>
WalkthroughAdded a "Breaking Changes" section to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 📜 Recent review detailsConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @js/Readme.md:
- Around line 15-42: The docs use inconsistent parameter names in the
breaking-changes summary: change the `valueMapperFunction?` mention for
`decodeMappedData` to `valueMapper?` so it matches the rest of the documentation
and the `getMappedData(jsonData, keyMapper, valueMapper, cborEnable?)`
signature; update the summary text where `decodeMappedData(data, keyMapper,
valueMapperFunction?)` appears to `decodeMappedData(data, keyMapper,
valueMapper?)`, ensuring both `getMappedData` and `decodeMappedData` use
`valueMapper` consistently.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
js/Readme.md
🔇 Additional comments (1)
js/Readme.md (1)
15-42: Excellent breaking changes documentation with clear migration path.The new "Breaking Changes" section is well-structured and provides clear API contract updates. The detailed documentation sections for both
getMappedData()anddecodeMappedData()include comprehensive parameter descriptions, practical examples, and proper deprecation/breaking change notices. The migration guide (lines 237–255) effectively walks users through the changes with before/after code examples and a clear "Key differences" section.Also applies to: 143-235
Signed-off-by: srikanth716 <srikanthsri7447@gmail.com>
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.