Readable y Writable streams

Clase 11 de 48 • Curso de Backend con Node.js 2019

Clase anteriorSiguiente clase

Resumen

Los Readable y Writeable streams tienen los siguientes eventos y funciones respectivamente:

Readable

Eventos

data. Se dispara cuando recibe datos.
end. Se dispara cuando termina de recibir datos.
error. Se dispara cuando hay un error.

Funciones

pipe
unpipe
read
push

Writeable

Eventos

drain. Se dispara cuando emite datos.
finish. Se dispara cuando termina de emitir.
error. Se dispara cuando hay un error.

Funciones

write
end

Recuerda que tienen estos eventos porque los heredan de la clase EventEmitter.

Paolo Donato Torregrosa Navarro

student•

Si como yo tuvieron problemas entendiendo esta clase, les dejo una buena info (si manejan ingles) sobre streams de node espero les sea útil :3

Maximo Martinez Soria

student•

Wow es una explicación increiblemente parecida a la de este curso jajaja

Javier Armando Vargas Vega

student•

Es prácticamente lo mismo que se ve en la clase. Quién copiaría a quién??

Juan Carlos García Esquivel

student•

writable-stream.js

//importamos Writable del módulo de streams
const { Writable } = require('stream')

/**
 * Creamos un nuevo Writable y lo asignamos
 * a la constante writableStream
 */
const writableStream = new Writable({
  defaultEncoding: 'utf8',
  /**
   *
   * @param {*} chunk el buffer de entrada
   * @param {*} encoding la codificación
   * del buffer, si el chunk es un string
   * el enconding es la codificación en
   * caracteres de esa cadena, si la
   * codificación es un buffer esta se puede
   * ignorar
   * @param {*} callback esta función es
   * llamada cuando se complete el
   * procesamiento para el chunk
   * proporcionado.
   */
  write(chunk, encoding, callback) {
    console.log(chunk.toString())
    callback()
  }
})
process.stdin.pipe(writableStream)

readable-stream.js

//requerimos el módulo de Readable stream
const { Readable } = require('stream')
//instanciamos un nuevo Readable stream
const readableStream = new Readable()
/**
 * Cuando se ejecuta el método push()
 * los datos son almacenados en el buffer
 * si no se consumen los datos en el buffer 
 * estos se almacenan en la cola interna 
 * hasta que son consumidos
 */
readableStream.push(`${0 / 0}`.repeat(10).concat(' Batman, Batman!'))
/**
 * El stream de lectura se da por terminado
 * cuándo el buffer recibe un null en este caso
 * con el método push(null)
 */
readableStream.push(null)

/**
 * "pipe(writable)" Este método nos permite 
 * encadenar diferentes streams para su 
 * manipulación por medio de cómputos. Lo que
 * hace es recibir un stream
 * de entrada, realiza una operación sobre 
 * dicho stream y devuelve un nuevo stream con
 * dicha transformación.
 * 
 * "stdout" es un writable stream que toma el 
 * buffer y lo muestra en pantalla
 */
readableStream.pipe(process.stdout)

readable-stream-on-demand.js

//importamos el modulo readable
const { Readable } = require('stream')

//instanciamos un nuevo readable stream
const readableStream = new Readable({
  /**
   * constructor
   * @param {*} size tamaño del buffer
   * de lectura este se representa en bytes
   * y el valor por defecto es 16kb para un
   * readable stream y para fs es de 64kb
   * parámetro opcional
   */
  read(size) {
    setTimeout(() => {
      //la letra es mayor que z
      if (this.chartCode > 90) {
        //finalizamos la lectura
        this.push(null)
        return;
      }
      /**
       * agregamos la letra al buffer y después
       * se le suma 1 
       */
      this.push(String.fromCharCode(this.chartCode++))
    }, 100)
  }
})

/**
 * inicializamos el atributo chartCode
 * y le asignamos el valor  ASCII de la letra A
 */
readableStream.chartCode = 65
/**
 * manejamos el stream de lectura y le asignamos
 * un stream de salida por pantalla
 */
readableStream.pipe(process.stdout)

María Jimena Rodríguez Contreras

student•

gracias

Sebastian

student•

jajajajja NaN NaN Batman!!! Batman!! la mejor parte de la clase

yerson lasso

student•

la pieza de código más graciosa que he visto en un tiempo jaja

María Jimena Rodríguez Contreras

student•

se te queda grabado

David Behar

student•

Si les cuesta trabajo entender el process.stdout, cuando corremos un programa en consola tenemos 3 outputs posibles

standard input (stdin)
standard output (stdout)
standard error (stderr) . El output es lo que mostramos en consola el input es el argumento que le damos al programa, todo lo que sigue al programa.js El error es un número que regresamos dependiendo del error que queramos mostrar (Puede no ser un número)

Por lo mismo, hice el siguiente programa usando lo que vimos en Readable y Writable, pero el output del Readable se tomará como argumento del Writable. Así:

const  {Writable, Readable} = require( 'stream' );

const  readableStream = new Readable();
readableStream.push(`${0/0} `.repeat(10).concat('Batman! Batman\n'))
readableStream.push(null);
readableStream.pipe(process.stdin);

const  writableStream = new Writable({
    write(chunk, encoding, callback){
        console.log(chunk.toString());
        callback()
    }

});

process.stdin.pipe(writableStream);

María Jimena Rodríguez Contreras

student•

gracias

Alexander Nova Arevalo

student•

#QueTrucazo de NaN NaN NaN NaN NaN NaN NaN NaN NaN NaN Batman, Batman!

Jimmy Buriticá Londoño

student•

😊

Carlos Gutierrez [C6]

student•

Aqui esta el char code que se menciona en la clase

Daniel Páez

student•

Usó el número 90 porque ese es el código ASCII de la Z, la última letra del abecedario.

Acá hay varios códigos ASCII por si alguno andaba perdido: https://ascii.cl/

Robert Gutiérrez

student•

Es bastante confuso, la forma en la que pronuncia readable, casi igual que writable, creo que se pronuncia ridabol, no raidabol, por otro lado pienso que no se está explicando nada, solo pone código en cada clase, pero no explica las cosas, por ejemplo en esta clase está process que es una variable global instancia de EventEmitter, pero en ningún momento la explicó

Ignacio Basilio

student•

La verdad comparto mucho lo que estas diciendo en este comentario. No siento que este explicando nada.

Juan Burns

student•

que es ${0/0} ????? no entendi de donde saco el NANNANNAN. ayuda! gracias!

Favio Sauto

student•

El resultado en Js de 0/0 (0 divido entre 0) es de NAN, lo que viene siendo Not A Number, eso lo repite 10 veces con la función repeat y queda NANNANNANNANNANNANNANNANNANNAN

Luis Gerardo López Hernández

student•

el resultado de 0 / 0 no existe. Por eso regresa NaN Not a Number

Daniel Páez

student•

Esto me recuerda mucho a la clase de terminal.

El pipe en terminal es este signo " | " , en la terminal el std_out , es el output que manda cuando ingresamos un comando. El std_in por lógica el input que le enviamos en los comandos.

¿Nodejs y los servidores en general son una capa de abstración sobre bash?

Guillermo Rodas

teacher•

bash es solo un tipo de prompt de la terminal, la terminal en si es una interfaz del sistema operativo.

Asis Melgarejo Lopez

student•

Todos los streams son instancias de EventEmitter.

Santiago Ortiz Ceballos

student•

Me perdí un poco al final, me pueden aclarar este par de dudas porfa?

Para qué sirve el parámetro "size" que recibe el readable stream que nunca se usa?
Cómo logran leerse las 25 letras del abecedario si la función que ejecuta el readable es un timeout y no un interval? En que momento se ejecuta múltiples veces?

Daniel Adolfo Ordoñez Rubio

student•

Hola, Santiago :) Te respondo en orden:

El parámetro size indica cuántos datos queremos leer, si no lo declaramos, se leen todos; que suele ser el caso, porque si no tendríamos que determinar cuantos datos hay para no excedernos o quedarnos cortos al leer.
La razón por la que se repite el código y el timeout, es porque está dentro del método read(), y este se llama cada vez que el readableStream lee algo, cuando le hacemos push() con un valor diferente a null

this.push(String.fromCharCode(this.chartCode++))
    }, 100)
  }
})

El push del chartCode++ hace que se repita la llamada a read con el siguiente caracter o letra del abecedario, que repite el timeout, que repite el push, hasta que el currentChardCode sea mayor a 90, o sea que llegamos a la letra "z"

if (this.chartCode > 90) {
  //finaliza la lectura
  this.push(null)
  return;
}

Santiago Ortiz Ceballos

student•

Muchas gracias Dani! ahora me queda claro :)

Abigail Perez

student•

porque la constante la declara entre llaves?

Nicolás Arias González

student•

Es una sintaxis abreviada para obtener valores de un objeto.

const { Readable } = require('stream'); Es equivalente a const Readable = require('stream').Readable;

Abigail Perez

student•

Entonces Readable es objeto de el modulo "stream" ?

Marifer Villarroel

student•

¿En que casos se hace uso de los streams Readable y Writable ?

Guillermo Rodas

teacher•

Creo que la clase responde esa pregunta. 😉Pero una aplicación real por ejemplo, es la manera como esta construida Express, así las peticiones HTTP pueden manejar largos set de datos sin sobrecargar la memoria del servidor.

Jorge Méndez Ortega

student•

Para estos casos podría cargarlo en la lectura de estáticos(practicamente assets y bundles),

Ever Alfredo Sorto Ayala

student•

tengo una duda,

const { write } = require('fs');
const  {Writable} = require('stream');


const writebleStream = new Writable({
   write(chunk, encodeing,callbak){
       console.log(chunk.toString());
      callbak();
   }
})

process.stdin.pipe(writebleStream);```

¿que hace el callback aqui?
 no le encuentro funcionalidad

Daniel Adolfo Ordoñez Rubio

student•

Hola, Ever :) El método write llama al callback al finalizar o si hay un error, llamarlo en el código una forma de decirla que ya terminó. Te dejo el enlace a la documentación aquí, y también lo encuentras en los recursos de la clase.

Puedes compararlo con el objeto Promise que recibe dos callbacks, resolve y reject; y llamando a cualquiera de los dos dentro del promise hacemos que termine.

German Cavani

student•

Harold Velasquez Barona

student•

No entendí para que el size si nunca lo usa?

Juan Carlos García Esquivel

student•

cuando se crea un stream se puede definir el tamaño (size) del buffer, este tamaño representa el número de bytes que el buffer puede almacenar, esto lo puedes utilizar cuando tienes un tamaño de memoria limitado y quieres asegurarte que el buffer no sobrepasen un tamaño que perjudique tu servidor, esto no se menciona en el video pero este size se define en el constructor (el método read(size)) del readable stream, este parámetro es opcional y por defecto es de 16kb para un readable stream normal y de 64kb para un readable stream del fs.

Espero haberte ayudado, por si no me explique bien acá te dejo un enlace con mas info del size Read size

Wilmar Yoan Malaver Malaver

student•

me gusto mucho lo de NaN NaN NaN NaN Batman, Batman! no me lo esperaba jjejeje

Carlos Enrique Ramírez Flores

student•

Aquí la lista de ASCII CODE! https://ascii.cl/

Daniel Sánchez

teacher•

Repositorio de la clase: https://github.com/glrodasz/platzi-backend-node/tree/readable-y-writable-streams/learning-node