Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Streams

Aperta
#2 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

@CrabDude ci sta già lavorando.

Dal 5/5/2015.

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

help wanted
  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 #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

Lingua principale
Nessun dato sulla lingua
Stelle
74
Fork
18
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di codepath/nodejs_guides

Tutte le issue di codepath/nodejs_guides

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.