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

Revise backpressure examples in streams documentation

Abierto
#94 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
45/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript, node.js
Área
documentation

Línea de trabajo

Empieza revisando la documentación actual sobre streams y backpressure, junto con su ejemplo de compresión; después, consulta la discusión y el pull request 90 mencionado para obtener contexto. Se considera terminado cuando la documentación contrasta las APIs de buffering y streaming de Node.js, incluye ejemplos de CommonJS y ESM, explica la backpressure ignorada y sus consecuencias para la memoria, y elimina la nota sobre la comparación de archivos comprimidos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Problem

The current backpressure documentation contains examples that may be confusing or technically inaccurate.

Specifically:

The compression example uses the zip command in a way that does not clearly demonstrate the role of Node.js stream backpressure.
It implies that using a command-line compression utility loads the entire file into memory, which is generally not true and depends on the implementation.
The example focuses on comparing archive outputs rather than illustrating the memory and throughput implications of buffering versus streaming.

See discussion: https://stackoverflow.com/questions/79821132/node-js-back-pressure-documentation-whats-the-relevance-of-their-example

Proposed Solution

Update the examples to use Node.js APIs directly:

Replace the current zip example with fs.readFileSync() + zlib.gzipSync() examples (CommonJS and ESM variants) to demonstrate a buffering approach.
Add a corresponding streaming example using Node.js streams and zlib.createGzip().
Include an explicit example showing a stream implementation that ignores backpressure and explain why it can lead to excessive memory consumption or out-of-memory conditions.
Remove the note about comparing the resulting archives, as it does not help explain backpressure behavior.

Motivation

The primary goal of the backpressure documentation should be to help readers understand how streams regulate data flow and memory usage. Using examples based entirely on Node.js APIs makes the comparison clearer

https://github.com/nodejs/learn/pull/90

Lenguaje dominante
JavaScript
Estrellas
29
Forks
165
Merge medio
1 d 18 h
PR fusionados (30 d)
2

Guía de contribución

Abrir la guía de contribución

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 nodejs/learn

Todos los issues de nodejs/learn

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.