Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Streams

Abierto
  • ¿Algo no está bien?
#2 0 comentarios 0 reacciones 1 asignado Ver en GitHub

@CrabDude ya está trabajando en esto.

Desde el 5/5/2015.

Evaluación

Este issue todavía no se ha evaluado.

Descripción

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

Lenguaje dominante
Sin datos de lenguaje
Estrellas
74
Forks
18
Sin PR fusionados en 30 d

Preparar el entorno

Aún no hemos revisado los archivos de configuración de este proyecto. Empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de codepath/nodejs_guides

Todos los issues de codepath/nodejs_guides

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.