Skip to content
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

Streams #2

Open
CrabDude opened this issue Apr 24, 2015 · 0 comments
Open

Streams #2

CrabDude opened this issue Apr 24, 2015 · 0 comments
Assignees
Milestone

Comments

@CrabDude
Copy link
Contributor

  1. Break the below into coherent sections
  2. Explain unix pipes and their corollary with node.js streams (explaining the concept of node.js streams as well)
  3. Explain the need for streams (memory pressure, decreased latency, CPU amortization & convenience)
  4. Lead with .pipe examples
    • Emphasize that source streams can be piped to multiple destination streams
    • Show example of piping from multiple source streams (readable.pipe(writable, {end: false}))
  5. Cover the basics: .read(), .write(), .pause(), .resume & events: 'data', 'close', 'error'
  6. Mention briefly push vs pull-based streams and how Streams 2/3 uses pull streams
  7. Mention how back-pressure is handled
  8. Briefly explain buffers, link to a reference (docs or blog post or guide), and show String(buffer)
  9. 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.
  10. Provide a common use case (e.g., A common type of duplex stream would be a WebSocket).
  11. Strongly recommend working through the stream-adventure nodeschool.io workshop and provide a screen shot of the stream-adventure exercise selection menu.

Advanced section:

  1. Explain object mode briefly, provide minimalist example and provide link to a more comprehensive explanation
  2. Provide code samples on how to create your own streams (i.e., .push, _read, _write & _transform) and additional links
  3. Show of JSON streaming example & explain !!LOUDLY!! how JSON.parse/stringify are the Master List: Cliffnote Topic Requests #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.

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

@CrabDude CrabDude added this to the week 1 milestone Apr 24, 2015
@CrabDude CrabDude self-assigned this May 5, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant