docs: document binary data support - #359
Open
xianjianlf2 wants to merge 1 commit into
Open
Conversation
| const { json, meta } = superjson.serialize({ bytes }); | ||
|
|
||
| // json === { bytes: [1, 2, 3] } | ||
| // meta === { values: { bytes: [['typed-array', 'Uint8Array']] } } |
There was a problem hiding this comment.
Include the metadata version field
The equality example presents the complete meta result, but serialize always adds v: 1 when metadata exists. Exact comparisons based on this documented shape therefore fail.
Suggested change
| // meta === { values: { bytes: [['typed-array', 'Uint8Array']] } } | |
| // meta === { values: { bytes: [['typed-array', 'Uint8Array']] }, v: 1 } |
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 283
Comment:
**Include the metadata version field**
The equality example presents the complete `meta` result, but `serialize` always adds `v: 1` when metadata exists. Exact comparisons based on this documented shape therefore fail.
```suggestion
// meta === { values: { bytes: [['typed-array', 'Uint8Array']] }, v: 1 }
```
---
For each issue above, determine whether it is valid and should be fixed. If so, fix it directly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #255
Summary
Validation
git diff --checkGreptile Summary
Adds documentation for SuperJSON's typed-array support and explains how binary data is represented during serialization.
Uint8Arrayround-trip example with its JSON and metadata representation.Confidence Score: 4/5
The PR appears safe to merge, with one non-blocking correction needed to make the documented metadata shape exact.
Typed arrays and the shown API usage match the implementation, but serialization always adds
v: 1to metadata while the new equality example omits it.Files Needing Attention: README.md
Important Files Changed
v: 1field.Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "docs: document binary data support" | Re-trigger Greptile