-
-
Notifications
You must be signed in to change notification settings - Fork 35.5k
doc: guide/topic on how to use streams #8646
Copy link
Copy link
Closed
nodejs/nodejs.org
#7123Labels
docIssues and PRs related to the documentations.Issues and PRs related to the documentations.help wantedIssues that need assistance from volunteers or PRs that need help to proceed.Issues that need assistance from volunteers or PRs that need help to proceed.streamIssues and PRs related to the stream subsystem.Issues and PRs related to the stream subsystem.
Metadata
Metadata
Assignees
Labels
docIssues and PRs related to the documentations.Issues and PRs related to the documentations.help wantedIssues that need assistance from volunteers or PRs that need help to proceed.Issues that need assistance from volunteers or PRs that need help to proceed.streamIssues and PRs related to the stream subsystem.Issues and PRs related to the stream subsystem.
From the discussion at NIEU2016 it emerged that the streams docs is not user friendly, and too focused on people that already know how to compose applications using streams. They describe the API, not how to use node streams in practice. In particular, it does not highlight the use of "streams modules": through2, from2, flush-write-stream, split2, pump, end-of-stream, duplexify, bl, etc.. and most of the things that are exposed via https://github.com/maxogden/mississippi. Moreover, it does not clarify how the API exposed to core fits in the picture, and how to build applications on streams.
The work done by @substack on the streams handbook is a great starting point: https://github.com/substack/stream-handbook.
cc @nodejs/streams @nodejs/documentation