Document how to stream JSON arrays #96
Merged
Conversation
This file contains 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
sindresorhus
requested changes
Aug 12, 2023
readme.md
Outdated
|
|
||
| const stream = fs.createReadStream('big-array-of-objects.json', {encoding: 'utf8'}); | ||
| console.log(await getStreamAsArray( | ||
| stream.pipe(streamJson.parser()).pipe(streamJsonArray.streamArray()), |
There was a problem hiding this comment.
pipeline is generally recommended instead of pipe methods.
There was a problem hiding this comment.
That's right! Good catch.
What about compose() instead? While pipeline() consumes the stream and returns a promise resolving when done (which would conflict with getStreamAsArray() consuming it too), compose() does not consume it and returns the stream.
There was a problem hiding this comment.
Yeah, compose is probably the right choice. I've been too used to (apparently) incorrectly using pipeline.
Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>
|
Fixed 👍 |
Closed
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.
This PR documents how to parse JSON array streams incrementally, as opposed to blocking the event loop once at the end using
JSON.parse().This does not cover actual JSON streams formats (where each line is a single object, and there are no
[]delimiters) although the utility mentioned supports those too.