Mention briefly push vs pull-based streams and how Streams 2/3 uses pull streams
Mention how back-pressure is handled
Briefly explain buffers, link to a reference (docs or blog post or guide), and show String(buffer)
Show 2 simple as possible examples of consuming (read: piping) each of the 4 stream types. You should use the most common examples e.g., req/res, through, fs read/write.
Provide a common use case (e.g., A common type of duplex stream would be a WebSocket).
Strongly recommend working through the stream-adventure nodeschool.io workshop and provide a screen shot of the stream-adventure exercise selection menu.
Advanced section:
Explain object mode briefly, provide minimalist example and provide link to a more comprehensive explanation
Provide code samples on how to create your own streams (i.e., .push, _read, _write & _transform) and additional links
Show of JSON streaming example & explain !!LOUDLY!! how JSON.parse/stringify are the #1 cause of CPU blocking in node.js
The stream handbook is nice, but it's too verbose and needs more structure. In general the examples are good, so use them.
.pipe
examplesreadable.pipe(writable, {end: false})
)String(buffer)
Advanced section:
The stream handbook is nice, but it's too verbose and needs more structure. In general the examples are good, so use them.
What success looks like: Succinctness and clarity. Less is more. Reference Wikis: Authentication & Authorization, Setup
Open separate issues for required links to community sources if you're having trouble finding any.
Please assign to yourself before working on this. /cc @NinjaSudo @philster @azoff @DiyahM