Source Code: lib/stream.js
\nA stream is an abstract interface for working with streaming data in Node.js.\nThe stream module provides an API for implementing the stream interface.
There are many stream objects provided by Node.js. For instance, a\nrequest to an HTTP server and process.stdout\nare both stream instances.
Streams can be readable, writable, or both. All streams are instances of\nEventEmitter.
To access the stream module:
const stream = require('stream');\nThe stream module is useful for creating new types of stream instances. It is\nusually not necessary to use the stream module to consume streams.
This document contains two primary sections and a third section for notes. The\nfirst section explains how to use existing streams within an application. The\nsecond section explains how to create new types of streams.
", "type": "module", "displayName": "Organization of this document" }, { "textRaw": "Types of streams", "name": "types_of_streams", "desc": "There are four fundamental stream types within Node.js:
\nWritable: streams to which data can be written (for example,\nfs.createWriteStream()).Readable: streams from which data can be read (for example,\nfs.createReadStream()).Duplex: streams that are both Readable and Writable (for example,\nnet.Socket).Transform: Duplex streams that can modify or transform the data as it\nis written and read (for example, zlib.createDeflate()).Additionally, this module includes the utility functions\nstream.pipeline(), stream.finished() and\nstream.Readable.from().
All streams created by Node.js APIs operate exclusively on strings and Buffer\n(or Uint8Array) objects. It is possible, however, for stream implementations\nto work with other types of JavaScript values (with the exception of null,\nwhich serves a special purpose within streams). Such streams are considered to\noperate in \"object mode\".
Stream instances are switched into object mode using the objectMode option\nwhen the stream is created. Attempting to switch an existing stream into\nobject mode is not safe.
Both Writable and Readable streams will store data in an internal\nbuffer.
The amount of data potentially buffered depends on the highWaterMark option\npassed into the stream's constructor. For normal streams, the highWaterMark\noption specifies a total number of bytes. For streams operating\nin object mode, the highWaterMark specifies a total number of objects.
Data is buffered in Readable streams when the implementation calls\nstream.push(chunk). If the consumer of the Stream does not\ncall stream.read(), the data will sit in the internal\nqueue until it is consumed.
Once the total size of the internal read buffer reaches the threshold specified\nby highWaterMark, the stream will temporarily stop reading data from the\nunderlying resource until the data currently buffered can be consumed (that is,\nthe stream will stop calling the internal readable._read() method that is\nused to fill the read buffer).
Data is buffered in Writable streams when the\nwritable.write(chunk) method is called repeatedly. While the\ntotal size of the internal write buffer is below the threshold set by\nhighWaterMark, calls to writable.write() will return true. Once\nthe size of the internal buffer reaches or exceeds the highWaterMark, false\nwill be returned.
A key goal of the stream API, particularly the stream.pipe() method,\nis to limit the buffering of data to acceptable levels such that sources and\ndestinations of differing speeds will not overwhelm the available memory.
The highWaterMark option is a threshold, not a limit: it dictates the amount\nof data that a stream buffers before it stops asking for more data. It does not\nenforce a strict memory limitation in general. Specific stream implementations\nmay choose to enforce stricter limits but doing so is optional.
Because Duplex and Transform streams are both Readable and\nWritable, each maintains two separate internal buffers used for reading and\nwriting, allowing each side to operate independently of the other while\nmaintaining an appropriate and efficient flow of data. For example,\nnet.Socket instances are Duplex streams whose Readable side allows\nconsumption of data received from the socket and whose Writable side allows\nwriting data to the socket. Because data may be written to the socket at a\nfaster or slower rate than data is received, each side should\noperate (and buffer) independently of the other.
The mechanics of the internal buffering are an internal implementation detail\nand may be changed at any time. However, for certain advanced implementations,\nthe internal buffers can be retrieved using writable.writableBuffer or\nreadable.readableBuffer. Use of these undocumented properties is discouraged.
A function to get notified when a stream is no longer readable, writable\nor has experienced an error or a premature close event.
\nconst { finished } = require('stream');\n\nconst rs = fs.createReadStream('archive.tar');\n\nfinished(rs, (err) => {\n if (err) {\n console.error('Stream failed.', err);\n } else {\n console.log('Stream is done reading.');\n }\n});\n\nrs.resume(); // Drain the stream.\nEspecially useful in error handling scenarios where a stream is destroyed\nprematurely (like an aborted HTTP request), and will not emit 'end'\nor 'finish'.
The finished API is promisify-able as well;
const finished = util.promisify(stream.finished);\n\nconst rs = fs.createReadStream('archive.tar');\n\nasync function run() {\n await finished(rs);\n console.log('Stream is done reading.');\n}\n\nrun().catch(console.error);\nrs.resume(); // Drain the stream.\nstream.finished() leaves dangling event listeners (in particular\n'error', 'end', 'finish' and 'close') after callback has been\ninvoked. The reason for this is so that unexpected 'error' events (due to\nincorrect stream implementations) do not cause unexpected crashes.\nIf this is unwanted behavior then the returned cleanup function needs to be\ninvoked in the callback:
const cleanup = finished(rs, (err) => {\n cleanup();\n // ...\n});\nA module method to pipe between streams and generators forwarding errors and\nproperly cleaning up and provide a callback when the pipeline is complete.
\nconst { pipeline } = require('stream');\nconst fs = require('fs');\nconst zlib = require('zlib');\n\n// Use the pipeline API to easily pipe a series of streams\n// together and get notified when the pipeline is fully done.\n\n// A pipeline to gzip a potentially huge tar file efficiently:\n\npipeline(\n fs.createReadStream('archive.tar'),\n zlib.createGzip(),\n fs.createWriteStream('archive.tar.gz'),\n (err) => {\n if (err) {\n console.error('Pipeline failed.', err);\n } else {\n console.log('Pipeline succeeded.');\n }\n }\n);\nThe pipeline API is promisify-able as well:
const pipeline = util.promisify(stream.pipeline);\n\nasync function run() {\n await pipeline(\n fs.createReadStream('archive.tar'),\n zlib.createGzip(),\n fs.createWriteStream('archive.tar.gz')\n );\n console.log('Pipeline succeeded.');\n}\n\nrun().catch(console.error);\nThe pipeline API also supports async generators:
const pipeline = util.promisify(stream.pipeline);\nconst fs = require('fs');\n\nasync function run() {\n await pipeline(\n fs.createReadStream('lowercase.txt'),\n async function* (source) {\n source.setEncoding('utf8'); // Work with strings rather than `Buffer`s.\n for await (const chunk of source) {\n yield chunk.toUpperCase();\n }\n },\n fs.createWriteStream('uppercase.txt')\n );\n console.log('Pipeline succeeded.');\n}\n\nrun().catch(console.error);\nstream.pipeline() will call stream.destroy(err) on all streams except:
Readable streams which have emitted 'end' or 'close'.Writable streams which have emitted 'finish' or 'close'.stream.pipeline() leaves dangling event listeners on the streams\nafter the callback has been invoked. In the case of reuse of streams after\nfailure, this can cause event listener leaks and swallowed errors.
A module method to pipe between streams and generators forwarding errors and\nproperly cleaning up and provide a callback when the pipeline is complete.
\nconst { pipeline } = require('stream');\nconst fs = require('fs');\nconst zlib = require('zlib');\n\n// Use the pipeline API to easily pipe a series of streams\n// together and get notified when the pipeline is fully done.\n\n// A pipeline to gzip a potentially huge tar file efficiently:\n\npipeline(\n fs.createReadStream('archive.tar'),\n zlib.createGzip(),\n fs.createWriteStream('archive.tar.gz'),\n (err) => {\n if (err) {\n console.error('Pipeline failed.', err);\n } else {\n console.log('Pipeline succeeded.');\n }\n }\n);\nThe pipeline API is promisify-able as well:
const pipeline = util.promisify(stream.pipeline);\n\nasync function run() {\n await pipeline(\n fs.createReadStream('archive.tar'),\n zlib.createGzip(),\n fs.createWriteStream('archive.tar.gz')\n );\n console.log('Pipeline succeeded.');\n}\n\nrun().catch(console.error);\nThe pipeline API also supports async generators:
const pipeline = util.promisify(stream.pipeline);\nconst fs = require('fs');\n\nasync function run() {\n await pipeline(\n fs.createReadStream('lowercase.txt'),\n async function* (source) {\n source.setEncoding('utf8'); // Work with strings rather than `Buffer`s.\n for await (const chunk of source) {\n yield chunk.toUpperCase();\n }\n },\n fs.createWriteStream('uppercase.txt')\n );\n console.log('Pipeline succeeded.');\n}\n\nrun().catch(console.error);\nstream.pipeline() will call stream.destroy(err) on all streams except:
Readable streams which have emitted 'end' or 'close'.Writable streams which have emitted 'finish' or 'close'.stream.pipeline() leaves dangling event listeners on the streams\nafter the callback has been invoked. In the case of reuse of streams after\nfailure, this can cause event listener leaks and swallowed errors.
A utility method for creating readable streams out of iterators.
\nconst { Readable } = require('stream');\n\nasync function * generate() {\n yield 'hello';\n yield 'streams';\n}\n\nconst readable = Readable.from(generate());\n\nreadable.on('data', (chunk) => {\n console.log(chunk);\n});\nCalling Readable.from(string) or Readable.from(buffer) will not have\nthe strings or buffers be iterated to match the other streams semantics\nfor performance reasons.
There are some cases where it is necessary to trigger a refresh of the\nunderlying readable stream mechanisms, without actually consuming any\ndata. In such cases, it is possible to call readable.read(0), which will\nalways return null.
If the internal read buffer is below the highWaterMark, and the\nstream is not currently reading, then calling stream.read(0) will trigger\na low-level stream._read() call.
While most applications will almost never need to do this, there are\nsituations within Node.js where this is done, particularly in the\nReadable stream class internals.
Use of readable.push('') is not recommended.
Pushing a zero-byte string, Buffer or Uint8Array to a stream that is not in\nobject mode has an interesting side effect. Because it is a call to\nreadable.push(), the call will end the reading process.\nHowever, because the argument is an empty string, no data is added to the\nreadable buffer so there is nothing for a user to consume.
Almost all Node.js applications, no matter how simple, use streams in some\nmanner. The following is an example of using streams in a Node.js application\nthat implements an HTTP server:
\nconst http = require('http');\n\nconst server = http.createServer((req, res) => {\n // `req` is an http.IncomingMessage, which is a readable stream.\n // `res` is an http.ServerResponse, which is a writable stream.\n\n let body = '';\n // Get the data as utf8 strings.\n // If an encoding is not set, Buffer objects will be received.\n req.setEncoding('utf8');\n\n // Readable streams emit 'data' events once a listener is added.\n req.on('data', (chunk) => {\n body += chunk;\n });\n\n // The 'end' event indicates that the entire body has been received.\n req.on('end', () => {\n try {\n const data = JSON.parse(body);\n // Write back something interesting to the user:\n res.write(typeof data);\n res.end();\n } catch (er) {\n // uh oh! bad json!\n res.statusCode = 400;\n return res.end(`error: ${er.message}`);\n }\n });\n});\n\nserver.listen(1337);\n\n// $ curl localhost:1337 -d \"{}\"\n// object\n// $ curl localhost:1337 -d \"\\\"foo\\\"\"\n// string\n// $ curl localhost:1337 -d \"not json\"\n// error: Unexpected token o in JSON at position 1\nWritable streams (such as res in the example) expose methods such as\nwrite() and end() that are used to write data onto the stream.
Readable streams use the EventEmitter API for notifying application\ncode when data is available to be read off the stream. That available data can\nbe read from the stream in multiple ways.
Both Writable and Readable streams use the EventEmitter API in\nvarious ways to communicate the current state of the stream.
Duplex and Transform streams are both Writable and\nReadable.
Applications that are either writing data to or consuming data from a stream\nare not required to implement the stream interfaces directly and will generally\nhave no reason to call require('stream').
Developers wishing to implement new types of streams should refer to the\nsection API for stream implementers.
", "miscs": [ { "textRaw": "Writable streams", "name": "writable_streams", "desc": "Writable streams are an abstraction for a destination to which data is\nwritten.
\nExamples of Writable streams include:
process.stdout, process.stderrSome of these examples are actually Duplex streams that implement the\nWritable interface.
All Writable streams implement the interface defined by the\nstream.Writable class.
While specific instances of Writable streams may differ in various ways,\nall Writable streams follow the same fundamental usage pattern as illustrated\nin the example below:
const myStream = getWritableStreamSomehow();\nmyStream.write('some data');\nmyStream.write('some more data');\nmyStream.end('done writing data');\nThe 'close' event is emitted when the stream and any of its underlying\nresources (a file descriptor, for example) have been closed. The event indicates\nthat no more events will be emitted, and no further computation will occur.
A Writable stream will always emit the 'close' event if it is\ncreated with the emitClose option.
If a call to stream.write(chunk) returns false, the\n'drain' event will be emitted when it is appropriate to resume writing data\nto the stream.
// Write the data to the supplied writable stream one million times.\n// Be attentive to back-pressure.\nfunction writeOneMillionTimes(writer, data, encoding, callback) {\n let i = 1000000;\n write();\n function write() {\n let ok = true;\n do {\n i--;\n if (i === 0) {\n // Last time!\n writer.write(data, encoding, callback);\n } else {\n // See if we should continue, or wait.\n // Don't pass the callback, because we're not done yet.\n ok = writer.write(data, encoding);\n }\n } while (i > 0 && ok);\n if (i > 0) {\n // Had to stop early!\n // Write some more once it drains.\n writer.once('drain', write);\n }\n }\n}\nThe 'error' event is emitted if an error occurred while writing or piping\ndata. The listener callback is passed a single Error argument when called.
The stream is closed when the 'error' event is emitted unless the\nautoDestroy option was set to false when creating the\nstream.
After 'error', no further events other than 'close' should be emitted\n(including 'error' events).
The 'finish' event is emitted after the stream.end() method\nhas been called, and all data has been flushed to the underlying system.
const writer = getWritableStreamSomehow();\nfor (let i = 0; i < 100; i++) {\n writer.write(`hello, #${i}!\\n`);\n}\nwriter.on('finish', () => {\n console.log('All writes are now complete.');\n});\nwriter.end('This is the end\\n');\nThe 'pipe' event is emitted when the stream.pipe() method is called on\na readable stream, adding this writable to its set of destinations.
const writer = getWritableStreamSomehow();\nconst reader = getReadableStreamSomehow();\nwriter.on('pipe', (src) => {\n console.log('Something is piping into the writer.');\n assert.equal(src, reader);\n});\nreader.pipe(writer);\nThe 'unpipe' event is emitted when the stream.unpipe() method is called\non a Readable stream, removing this Writable from its set of\ndestinations.
This is also emitted in case this Writable stream emits an error when a\nReadable stream pipes into it.
const writer = getWritableStreamSomehow();\nconst reader = getReadableStreamSomehow();\nwriter.on('unpipe', (src) => {\n console.log('Something has stopped piping into the writer.');\n assert.equal(src, reader);\n});\nreader.pipe(writer);\nreader.unpipe(writer);\nThe writable.cork() method forces all written data to be buffered in memory.\nThe buffered data will be flushed when either the stream.uncork() or\nstream.end() methods are called.
The primary intent of writable.cork() is to accommodate a situation in which\nseveral small chunks are written to the stream in rapid succession. Instead of\nimmediately forwarding them to the underlying destination, writable.cork()\nbuffers all the chunks until writable.uncork() is called, which will pass them\nall to writable._writev(), if present. This prevents a head-of-line blocking\nsituation where data is being buffered while waiting for the first small chunk\nto be processed. However, use of writable.cork() without implementing\nwritable._writev() may have an adverse effect on throughput.
See also: writable.uncork(), writable._writev().
Destroy the stream. Optionally emit an 'error' event, and emit a 'close'\nevent (unless emitClose is set to false). After this call, the writable\nstream has ended and subsequent calls to write() or end() will result in\nan ERR_STREAM_DESTROYED error.\nThis is a destructive and immediate way to destroy a stream. Previous calls to\nwrite() may not have drained, and may trigger an ERR_STREAM_DESTROYED error.\nUse end() instead of destroy if data should flush before close, or wait for\nthe 'drain' event before destroying the stream.
const { Writable } = require('stream');\n\nconst myStream = new Writable();\n\nconst fooErr = new Error('foo error');\nmyStream.destroy(fooErr);\nmyStream.on('error', (fooErr) => console.error(fooErr.message)); // foo error\nconst { Writable } = require('stream');\n\nconst myStream = new Writable();\n\nmyStream.destroy();\nmyStream.on('error', function wontHappen() {});\nconst { Writable } = require('stream');\n\nconst myStream = new Writable();\nmyStream.destroy();\n\nmyStream.write('foo', (error) => console.error(error.code));\n// ERR_STREAM_DESTROYED\nOnce destroy() has been called any further calls will be a no-op and no\nfurther errors except from _destroy() may be emitted as 'error'.
Implementors should not override this method,\nbut instead implement writable._destroy().
Calling the writable.end() method signals that no more data will be written\nto the Writable. The optional chunk and encoding arguments allow one\nfinal additional chunk of data to be written immediately before closing the\nstream. If provided, the optional callback function is attached as a listener\nfor the 'finish' and the 'error' event.
Calling the stream.write() method after calling\nstream.end() will raise an error.
// Write 'hello, ' and then end with 'world!'.\nconst fs = require('fs');\nconst file = fs.createWriteStream('example.txt');\nfile.write('hello, ');\nfile.end('world!');\n// Writing more now is not allowed!\nThe writable.setDefaultEncoding() method sets the default encoding for a\nWritable stream.
The writable.uncork() method flushes all data buffered since\nstream.cork() was called.
When using writable.cork() and writable.uncork() to manage the buffering\nof writes to a stream, it is recommended that calls to writable.uncork() be\ndeferred using process.nextTick(). Doing so allows batching of all\nwritable.write() calls that occur within a given Node.js event loop phase.
stream.cork();\nstream.write('some ');\nstream.write('data ');\nprocess.nextTick(() => stream.uncork());\nIf the writable.cork() method is called multiple times on a stream, the\nsame number of calls to writable.uncork() must be called to flush the buffered\ndata.
stream.cork();\nstream.write('some ');\nstream.cork();\nstream.write('data ');\nprocess.nextTick(() => {\n stream.uncork();\n // The data will not be flushed until uncork() is called a second time.\n stream.uncork();\n});\nSee also: writable.cork().
The writable.write() method writes some data to the stream, and calls the\nsupplied callback once the data has been fully handled. If an error\noccurs, the callback may or may not be called with the error as its\nfirst argument. To reliably detect write errors, add a listener for the\n'error' event. The callback is called asynchronously and before 'error' is\nemitted.
The return value is true if the internal buffer is less than the\nhighWaterMark configured when the stream was created after admitting chunk.\nIf false is returned, further attempts to write data to the stream should\nstop until the 'drain' event is emitted.
While a stream is not draining, calls to write() will buffer chunk, and\nreturn false. Once all currently buffered chunks are drained (accepted for\ndelivery by the operating system), the 'drain' event will be emitted.\nIt is recommended that once write() returns false, no more chunks be written\nuntil the 'drain' event is emitted. While calling write() on a stream that\nis not draining is allowed, Node.js will buffer all written chunks until\nmaximum memory usage occurs, at which point it will abort unconditionally.\nEven before it aborts, high memory usage will cause poor garbage collector\nperformance and high RSS (which is not typically released back to the system,\neven after the memory is no longer required). Since TCP sockets may never\ndrain if the remote peer does not read the data, writing a socket that is\nnot draining may lead to a remotely exploitable vulnerability.
Writing data while the stream is not draining is particularly\nproblematic for a Transform, because the Transform streams are paused\nby default until they are piped or a 'data' or 'readable' event handler\nis added.
If the data to be written can be generated or fetched on demand, it is\nrecommended to encapsulate the logic into a Readable and use\nstream.pipe(). However, if calling write() is preferred, it is\npossible to respect backpressure and avoid memory issues using the\n'drain' event:
function write(data, cb) {\n if (!stream.write(data)) {\n stream.once('drain', cb);\n } else {\n process.nextTick(cb);\n }\n}\n\n// Wait for cb to be called before doing any other write.\nwrite('hello', () => {\n console.log('Write completed, do more writes now.');\n});\nA Writable stream in object mode will always ignore the encoding argument.
Is true after writable.destroy() has been called.
const { Writable } = require('stream');\n\nconst myStream = new Writable();\n\nconsole.log(myStream.destroyed); // false\nmyStream.destroy();\nconsole.log(myStream.destroyed); // true\nIs true if it is safe to call writable.write(), which means\nthe stream has not been destroyed, errored or ended.
Is true after writable.end() has been called. This property\ndoes not indicate whether the data has been flushed, for this use\nwritable.writableFinished instead.
Number of times writable.uncork() needs to be\ncalled in order to fully uncork the stream.
Is set to true immediately before the 'finish' event is emitted.
Return the value of highWaterMark passed when constructing this\nWritable.
This property contains the number of bytes (or objects) in the queue\nready to be written. The value provides introspection data regarding\nthe status of the highWaterMark.
Is true if the stream's buffer has been full and stream will emit 'drain'.
Getter for the property objectMode of a given Writable stream.
Readable streams are an abstraction for a source from which data is\nconsumed.
\nExamples of Readable streams include:
process.stdinAll Readable streams implement the interface defined by the\nstream.Readable class.
Readable streams effectively operate in one of two modes: flowing and\npaused. These modes are separate from object mode.\nA Readable stream can be in object mode or not, regardless of whether\nit is in flowing mode or paused mode.
In flowing mode, data is read from the underlying system automatically\nand provided to an application as quickly as possible using events via the\nEventEmitter interface.
In paused mode, the stream.read() method must be called\nexplicitly to read chunks of data from the stream.
All Readable streams begin in paused mode but can be switched to flowing\nmode in one of the following ways:
'data' event handler.stream.resume() method.stream.pipe() method to send the data to a Writable.The Readable can switch back to paused mode using one of the following:
stream.pause() method.stream.unpipe() method.The important concept to remember is that a Readable will not generate data\nuntil a mechanism for either consuming or ignoring that data is provided. If\nthe consuming mechanism is disabled or taken away, the Readable will attempt\nto stop generating the data.
For backward compatibility reasons, removing 'data' event handlers will\nnot automatically pause the stream. Also, if there are piped destinations,\nthen calling stream.pause() will not guarantee that the\nstream will remain paused once those destinations drain and ask for more data.
If a Readable is switched into flowing mode and there are no consumers\navailable to handle the data, that data will be lost. This can occur, for\ninstance, when the readable.resume() method is called without a listener\nattached to the 'data' event, or when a 'data' event handler is removed\nfrom the stream.
Adding a 'readable' event handler automatically makes the stream\nstop flowing, and the data has to be consumed via\nreadable.read(). If the 'readable' event handler is\nremoved, then the stream will start flowing again if there is a\n'data' event handler.
The \"two modes\" of operation for a Readable stream are a simplified\nabstraction for the more complicated internal state management that is happening\nwithin the Readable stream implementation.
Specifically, at any given point in time, every Readable is in one of three\npossible states:
readable.readableFlowing === nullreadable.readableFlowing === falsereadable.readableFlowing === trueWhen readable.readableFlowing is null, no mechanism for consuming the\nstream's data is provided. Therefore, the stream will not generate data.\nWhile in this state, attaching a listener for the 'data' event, calling the\nreadable.pipe() method, or calling the readable.resume() method will switch\nreadable.readableFlowing to true, causing the Readable to begin actively\nemitting events as data is generated.
Calling readable.pause(), readable.unpipe(), or receiving backpressure\nwill cause the readable.readableFlowing to be set as false,\ntemporarily halting the flowing of events but not halting the generation of\ndata. While in this state, attaching a listener for the 'data' event\nwill not switch readable.readableFlowing to true.
const { PassThrough, Writable } = require('stream');\nconst pass = new PassThrough();\nconst writable = new Writable();\n\npass.pipe(writable);\npass.unpipe(writable);\n// readableFlowing is now false.\n\npass.on('data', (chunk) => { console.log(chunk.toString()); });\npass.write('ok'); // Will not emit 'data'.\npass.resume(); // Must be called to make stream emit 'data'.\nWhile readable.readableFlowing is false, data may be accumulating\nwithin the stream's internal buffer.
The Readable stream API evolved across multiple Node.js versions and provides\nmultiple methods of consuming stream data. In general, developers should choose\none of the methods of consuming data and should never use multiple methods\nto consume data from a single stream. Specifically, using a combination\nof on('data'), on('readable'), pipe(), or async iterators could\nlead to unintuitive behavior.
Use of the readable.pipe() method is recommended for most users as it has been\nimplemented to provide the easiest way of consuming stream data. Developers that\nrequire more fine-grained control over the transfer and generation of data can\nuse the EventEmitter and readable.on('readable')/readable.read()\nor the readable.pause()/readable.resume() APIs.
The 'close' event is emitted when the stream and any of its underlying\nresources (a file descriptor, for example) have been closed. The event indicates\nthat no more events will be emitted, and no further computation will occur.
A Readable stream will always emit the 'close' event if it is\ncreated with the emitClose option.
The 'data' event is emitted whenever the stream is relinquishing ownership of\na chunk of data to a consumer. This may occur whenever the stream is switched\nin flowing mode by calling readable.pipe(), readable.resume(), or by\nattaching a listener callback to the 'data' event. The 'data' event will\nalso be emitted whenever the readable.read() method is called and a chunk of\ndata is available to be returned.
Attaching a 'data' event listener to a stream that has not been explicitly\npaused will switch the stream into flowing mode. Data will then be passed as\nsoon as it is available.
The listener callback will be passed the chunk of data as a string if a default\nencoding has been specified for the stream using the\nreadable.setEncoding() method; otherwise the data will be passed as a\nBuffer.
const readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n console.log(`Received ${chunk.length} bytes of data.`);\n});\nThe 'end' event is emitted when there is no more data to be consumed from\nthe stream.
The 'end' event will not be emitted unless the data is completely\nconsumed. This can be accomplished by switching the stream into flowing mode,\nor by calling stream.read() repeatedly until all data has been\nconsumed.
const readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n console.log(`Received ${chunk.length} bytes of data.`);\n});\nreadable.on('end', () => {\n console.log('There will be no more data.');\n});\nThe 'error' event may be emitted by a Readable implementation at any time.\nTypically, this may occur if the underlying stream is unable to generate data\ndue to an underlying internal failure, or when a stream implementation attempts\nto push an invalid chunk of data.
The listener callback will be passed a single Error object.
The 'pause' event is emitted when stream.pause() is called\nand readableFlowing is not false.
The 'readable' event is emitted when there is data available to be read from\nthe stream. In some cases, attaching a listener for the 'readable' event will\ncause some amount of data to be read into an internal buffer.
const readable = getReadableStreamSomehow();\nreadable.on('readable', function() {\n // There is some data to read now.\n let data;\n\n while (data = this.read()) {\n console.log(data);\n }\n});\nThe 'readable' event will also be emitted once the end of the stream data\nhas been reached but before the 'end' event is emitted.
Effectively, the 'readable' event indicates that the stream has new\ninformation: either new data is available or the end of the stream has been\nreached. In the former case, stream.read() will return the\navailable data. In the latter case, stream.read() will return\nnull. For instance, in the following example, foo.txt is an empty file:
const fs = require('fs');\nconst rr = fs.createReadStream('foo.txt');\nrr.on('readable', () => {\n console.log(`readable: ${rr.read()}`);\n});\nrr.on('end', () => {\n console.log('end');\n});\nThe output of running this script is:
\n$ node test.js\nreadable: null\nend\nIn general, the readable.pipe() and 'data' event mechanisms are easier to\nunderstand than the 'readable' event. However, handling 'readable' might\nresult in increased throughput.
If both 'readable' and 'data' are used at the same time, 'readable'\ntakes precedence in controlling the flow, i.e. 'data' will be emitted\nonly when stream.read() is called. The\nreadableFlowing property would become false.\nIf there are 'data' listeners when 'readable' is removed, the stream\nwill start flowing, i.e. 'data' events will be emitted without calling\n.resume().
The 'resume' event is emitted when stream.resume() is\ncalled and readableFlowing is not true.
Destroy the stream. Optionally emit an 'error' event, and emit a 'close'\nevent (unless emitClose is set to false). After this call, the readable\nstream will release any internal resources and subsequent calls to push()\nwill be ignored.
Once destroy() has been called any further calls will be a no-op and no\nfurther errors except from _destroy() may be emitted as 'error'.
Implementors should not override this method, but instead implement\nreadable._destroy().
The readable.isPaused() method returns the current operating state of the\nReadable. This is used primarily by the mechanism that underlies the\nreadable.pipe() method. In most typical cases, there will be no reason to\nuse this method directly.
const readable = new stream.Readable();\n\nreadable.isPaused(); // === false\nreadable.pause();\nreadable.isPaused(); // === true\nreadable.resume();\nreadable.isPaused(); // === false\nThe readable.pause() method will cause a stream in flowing mode to stop\nemitting 'data' events, switching out of flowing mode. Any data that\nbecomes available will remain in the internal buffer.
const readable = getReadableStreamSomehow();\nreadable.on('data', (chunk) => {\n console.log(`Received ${chunk.length} bytes of data.`);\n readable.pause();\n console.log('There will be no additional data for 1 second.');\n setTimeout(() => {\n console.log('Now data will start flowing again.');\n readable.resume();\n }, 1000);\n});\nThe readable.pause() method has no effect if there is a 'readable'\nevent listener.
The readable.pipe() method attaches a Writable stream to the readable,\ncausing it to switch automatically into flowing mode and push all of its data\nto the attached Writable. The flow of data will be automatically managed\nso that the destination Writable stream is not overwhelmed by a faster\nReadable stream.
The following example pipes all of the data from the readable into a file\nnamed file.txt:
const fs = require('fs');\nconst readable = getReadableStreamSomehow();\nconst writable = fs.createWriteStream('file.txt');\n// All the data from readable goes into 'file.txt'.\nreadable.pipe(writable);\nIt is possible to attach multiple Writable streams to a single Readable\nstream.
The readable.pipe() method returns a reference to the destination stream\nmaking it possible to set up chains of piped streams:
const fs = require('fs');\nconst r = fs.createReadStream('file.txt');\nconst z = zlib.createGzip();\nconst w = fs.createWriteStream('file.txt.gz');\nr.pipe(z).pipe(w);\nBy default, stream.end() is called on the destination Writable\nstream when the source Readable stream emits 'end', so that the\ndestination is no longer writable. To disable this default behavior, the end\noption can be passed as false, causing the destination stream to remain open:
reader.pipe(writer, { end: false });\nreader.on('end', () => {\n writer.end('Goodbye\\n');\n});\nOne important caveat is that if the Readable stream emits an error during\nprocessing, the Writable destination is not closed automatically. If an\nerror occurs, it will be necessary to manually close each stream in order\nto prevent memory leaks.
The process.stderr and process.stdout Writable streams are never\nclosed until the Node.js process exits, regardless of the specified options.
The readable.read() method pulls some data out of the internal buffer and\nreturns it. If no data available to be read, null is returned. By default,\nthe data will be returned as a Buffer object unless an encoding has been\nspecified using the readable.setEncoding() method or the stream is operating\nin object mode.
The optional size argument specifies a specific number of bytes to read. If\nsize bytes are not available to be read, null will be returned unless\nthe stream has ended, in which case all of the data remaining in the internal\nbuffer will be returned.
If the size argument is not specified, all of the data contained in the\ninternal buffer will be returned.
The size argument must be less than or equal to 1 GiB.
The readable.read() method should only be called on Readable streams\noperating in paused mode. In flowing mode, readable.read() is called\nautomatically until the internal buffer is fully drained.
const readable = getReadableStreamSomehow();\n\n// 'readable' may be triggered multiple times as data is buffered in\nreadable.on('readable', () => {\n let chunk;\n console.log('Stream is readable (new data received in buffer)');\n // Use a loop to make sure we read all currently available data\n while (null !== (chunk = readable.read())) {\n console.log(`Read ${chunk.length} bytes of data...`);\n }\n});\n\n// 'end' will be triggered once when there is no more data available\nreadable.on('end', () => {\n console.log('Reached end of stream.');\n});\nEach call to readable.read() returns a chunk of data, or null. The chunks\nare not concatenated. A while loop is necessary to consume all data\ncurrently in the buffer. When reading a large file .read() may return null,\nhaving consumed all buffered content so far, but there is still more data to\ncome not yet buffered. In this case a new 'readable' event will be emitted\nwhen there is more data in the buffer. Finally the 'end' event will be\nemitted when there is no more data to come.
Therefore to read a file's whole contents from a readable, it is necessary\nto collect chunks across multiple 'readable' events:
const chunks = [];\n\nreadable.on('readable', () => {\n let chunk;\n while (null !== (chunk = readable.read())) {\n chunks.push(chunk);\n }\n});\n\nreadable.on('end', () => {\n const content = chunks.join('');\n});\nA Readable stream in object mode will always return a single item from\na call to readable.read(size), regardless of the value of the\nsize argument.
If the readable.read() method returns a chunk of data, a 'data' event will\nalso be emitted.
Calling stream.read([size]) after the 'end' event has\nbeen emitted will return null. No runtime error will be raised.
The readable.resume() method causes an explicitly paused Readable stream to\nresume emitting 'data' events, switching the stream into flowing mode.
The readable.resume() method can be used to fully consume the data from a\nstream without actually processing any of that data:
getReadableStreamSomehow()\n .resume()\n .on('end', () => {\n console.log('Reached the end, but did not read anything.');\n });\nThe readable.resume() method has no effect if there is a 'readable'\nevent listener.
The readable.setEncoding() method sets the character encoding for\ndata read from the Readable stream.
By default, no encoding is assigned and stream data will be returned as\nBuffer objects. Setting an encoding causes the stream data\nto be returned as strings of the specified encoding rather than as Buffer\nobjects. For instance, calling readable.setEncoding('utf8') will cause the\noutput data to be interpreted as UTF-8 data, and passed as strings. Calling\nreadable.setEncoding('hex') will cause the data to be encoded in hexadecimal\nstring format.
The Readable stream will properly handle multi-byte characters delivered\nthrough the stream that would otherwise become improperly decoded if simply\npulled from the stream as Buffer objects.
const readable = getReadableStreamSomehow();\nreadable.setEncoding('utf8');\nreadable.on('data', (chunk) => {\n assert.equal(typeof chunk, 'string');\n console.log('Got %d characters of string data:', chunk.length);\n});\nThe readable.unpipe() method detaches a Writable stream previously attached\nusing the stream.pipe() method.
If the destination is not specified, then all pipes are detached.
If the destination is specified, but no pipe is set up for it, then\nthe method does nothing.
const fs = require('fs');\nconst readable = getReadableStreamSomehow();\nconst writable = fs.createWriteStream('file.txt');\n// All the data from readable goes into 'file.txt',\n// but only for the first second.\nreadable.pipe(writable);\nsetTimeout(() => {\n console.log('Stop writing to file.txt.');\n readable.unpipe(writable);\n console.log('Manually close the file stream.');\n writable.end();\n}, 1000);\nPassing chunk as null signals the end of the stream (EOF) and behaves the\nsame as readable.push(null), after which no more data can be written. The EOF\nsignal is put at the end of the buffer and any buffered data will still be\nflushed.
The readable.unshift() method pushes a chunk of data back into the internal\nbuffer. This is useful in certain situations where a stream is being consumed by\ncode that needs to \"un-consume\" some amount of data that it has optimistically\npulled out of the source, so that the data can be passed on to some other party.
The stream.unshift(chunk) method cannot be called after the 'end' event\nhas been emitted or a runtime error will be thrown.
Developers using stream.unshift() often should consider switching to\nuse of a Transform stream instead. See the API for stream implementers\nsection for more information.
// Pull off a header delimited by \\n\\n.\n// Use unshift() if we get too much.\n// Call the callback with (error, header, stream).\nconst { StringDecoder } = require('string_decoder');\nfunction parseHeader(stream, callback) {\n stream.on('error', callback);\n stream.on('readable', onReadable);\n const decoder = new StringDecoder('utf8');\n let header = '';\n function onReadable() {\n let chunk;\n while (null !== (chunk = stream.read())) {\n const str = decoder.write(chunk);\n if (str.match(/\\n\\n/)) {\n // Found the header boundary.\n const split = str.split(/\\n\\n/);\n header += split.shift();\n const remaining = split.join('\\n\\n');\n const buf = Buffer.from(remaining, 'utf8');\n stream.removeListener('error', callback);\n // Remove the 'readable' listener before unshifting.\n stream.removeListener('readable', onReadable);\n if (buf.length)\n stream.unshift(buf);\n // Now the body of the message can be read from the stream.\n callback(null, header, stream);\n } else {\n // Still reading the header.\n header += str;\n }\n }\n }\n}\nUnlike stream.push(chunk), stream.unshift(chunk) will not\nend the reading process by resetting the internal reading state of the stream.\nThis can cause unexpected results if readable.unshift() is called during a\nread (i.e. from within a stream._read() implementation on a\ncustom stream). Following the call to readable.unshift() with an immediate\nstream.push('') will reset the reading state appropriately,\nhowever it is best to simply avoid calling readable.unshift() while in the\nprocess of performing a read.
Prior to Node.js 0.10, streams did not implement the entire stream module API\nas it is currently defined. (See Compatibility for more information.)
When using an older Node.js library that emits 'data' events and has a\nstream.pause() method that is advisory only, the\nreadable.wrap() method can be used to create a Readable stream that uses\nthe old stream as its data source.
It will rarely be necessary to use readable.wrap() but the method has been\nprovided as a convenience for interacting with older Node.js applications and\nlibraries.
const { OldReader } = require('./old-api-module.js');\nconst { Readable } = require('stream');\nconst oreader = new OldReader();\nconst myReader = new Readable().wrap(oreader);\n\nmyReader.on('readable', () => {\n myReader.read(); // etc.\n});\nconst fs = require('fs');\n\nasync function print(readable) {\n readable.setEncoding('utf8');\n let data = '';\n for await (const chunk of readable) {\n data += chunk;\n }\n console.log(data);\n}\n\nprint(fs.createReadStream('file')).catch(console.error);\nIf the loop terminates with a break or a throw, the stream will be\ndestroyed. In other terms, iterating over a stream will consume the stream\nfully. The stream will be read in chunks of size equal to the highWaterMark\noption. In the code example above, data will be in a single chunk if the file\nhas less then 64KB of data because no highWaterMark option is provided to\nfs.createReadStream().
Is true after readable.destroy() has been called.
Is true if it is safe to call readable.read(), which means\nthe stream has not been destroyed or emitted 'error' or 'end'.
Allows determining if the stream has been or is about to be read.\nReturns true if 'data', 'end', 'error' or 'close' has been\nemitted.
Getter for the property encoding of a given Readable stream. The encoding\nproperty can be set using the readable.setEncoding() method.
Becomes true when 'end' event is emitted.
This property reflects the current state of a Readable stream as described\nin the Three states section.
Returns the value of highWaterMark passed when constructing this\nReadable.
This property contains the number of bytes (or objects) in the queue\nready to be read. The value provides introspection data regarding\nthe status of the highWaterMark.
Getter for the property objectMode of a given Readable stream.
Duplex streams are streams that implement both the Readable and\nWritable interfaces.
Examples of Duplex streams include:
Transform streams are Duplex streams where the output is in some way\nrelated to the input. Like all Duplex streams, Transform streams\nimplement both the Readable and Writable interfaces.
Examples of Transform streams include:
Destroy the stream, and optionally emit an 'error' event. After this call, the\ntransform stream would release any internal resources.\nImplementors should not override this method, but instead implement\nreadable._destroy().\nThe default implementation of _destroy() for Transform also emit 'close'\nunless emitClose is set in false.
Once destroy() has been called, any further calls will be a no-op and no\nfurther errors except from _destroy() may be emitted as 'error'.
A function to get notified when a stream is no longer readable, writable\nor has experienced an error or a premature close event.
\nconst { finished } = require('stream');\n\nconst rs = fs.createReadStream('archive.tar');\n\nfinished(rs, (err) => {\n if (err) {\n console.error('Stream failed.', err);\n } else {\n console.log('Stream is done reading.');\n }\n});\n\nrs.resume(); // Drain the stream.\nEspecially useful in error handling scenarios where a stream is destroyed\nprematurely (like an aborted HTTP request), and will not emit 'end'\nor 'finish'.
The finished API is promisify-able as well;
const finished = util.promisify(stream.finished);\n\nconst rs = fs.createReadStream('archive.tar');\n\nasync function run() {\n await finished(rs);\n console.log('Stream is done reading.');\n}\n\nrun().catch(console.error);\nrs.resume(); // Drain the stream.\nstream.finished() leaves dangling event listeners (in particular\n'error', 'end', 'finish' and 'close') after callback has been\ninvoked. The reason for this is so that unexpected 'error' events (due to\nincorrect stream implementations) do not cause unexpected crashes.\nIf this is unwanted behavior then the returned cleanup function needs to be\ninvoked in the callback:
const cleanup = finished(rs, (err) => {\n cleanup();\n // ...\n});\nA module method to pipe between streams and generators forwarding errors and\nproperly cleaning up and provide a callback when the pipeline is complete.
\nconst { pipeline } = require('stream');\nconst fs = require('fs');\nconst zlib = require('zlib');\n\n// Use the pipeline API to easily pipe a series of streams\n// together and get notified when the pipeline is fully done.\n\n// A pipeline to gzip a potentially huge tar file efficiently:\n\npipeline(\n fs.createReadStream('archive.tar'),\n zlib.createGzip(),\n fs.createWriteStream('archive.tar.gz'),\n (err) => {\n if (err) {\n console.error('Pipeline failed.', err);\n } else {\n console.log('Pipeline succeeded.');\n }\n }\n);\nThe pipeline API is promisify-able as well:
const pipeline = util.promisify(stream.pipeline);\n\nasync function run() {\n await pipeline(\n fs.createReadStream('archive.tar'),\n zlib.createGzip(),\n fs.createWriteStream('archive.tar.gz')\n );\n console.log('Pipeline succeeded.');\n}\n\nrun().catch(console.error);\nThe pipeline API also supports async generators:
const pipeline = util.promisify(stream.pipeline);\nconst fs = require('fs');\n\nasync function run() {\n await pipeline(\n fs.createReadStream('lowercase.txt'),\n async function* (source) {\n source.setEncoding('utf8'); // Work with strings rather than `Buffer`s.\n for await (const chunk of source) {\n yield chunk.toUpperCase();\n }\n },\n fs.createWriteStream('uppercase.txt')\n );\n console.log('Pipeline succeeded.');\n}\n\nrun().catch(console.error);\nstream.pipeline() will call stream.destroy(err) on all streams except:
Readable streams which have emitted 'end' or 'close'.Writable streams which have emitted 'finish' or 'close'.stream.pipeline() leaves dangling event listeners on the streams\nafter the callback has been invoked. In the case of reuse of streams after\nfailure, this can cause event listener leaks and swallowed errors.
A module method to pipe between streams and generators forwarding errors and\nproperly cleaning up and provide a callback when the pipeline is complete.
\nconst { pipeline } = require('stream');\nconst fs = require('fs');\nconst zlib = require('zlib');\n\n// Use the pipeline API to easily pipe a series of streams\n// together and get notified when the pipeline is fully done.\n\n// A pipeline to gzip a potentially huge tar file efficiently:\n\npipeline(\n fs.createReadStream('archive.tar'),\n zlib.createGzip(),\n fs.createWriteStream('archive.tar.gz'),\n (err) => {\n if (err) {\n console.error('Pipeline failed.', err);\n } else {\n console.log('Pipeline succeeded.');\n }\n }\n);\nThe pipeline API is promisify-able as well:
const pipeline = util.promisify(stream.pipeline);\n\nasync function run() {\n await pipeline(\n fs.createReadStream('archive.tar'),\n zlib.createGzip(),\n fs.createWriteStream('archive.tar.gz')\n );\n console.log('Pipeline succeeded.');\n}\n\nrun().catch(console.error);\nThe pipeline API also supports async generators:
const pipeline = util.promisify(stream.pipeline);\nconst fs = require('fs');\n\nasync function run() {\n await pipeline(\n fs.createReadStream('lowercase.txt'),\n async function* (source) {\n source.setEncoding('utf8'); // Work with strings rather than `Buffer`s.\n for await (const chunk of source) {\n yield chunk.toUpperCase();\n }\n },\n fs.createWriteStream('uppercase.txt')\n );\n console.log('Pipeline succeeded.');\n}\n\nrun().catch(console.error);\nstream.pipeline() will call stream.destroy(err) on all streams except:
Readable streams which have emitted 'end' or 'close'.Writable streams which have emitted 'finish' or 'close'.stream.pipeline() leaves dangling event listeners on the streams\nafter the callback has been invoked. In the case of reuse of streams after\nfailure, this can cause event listener leaks and swallowed errors.
A utility method for creating readable streams out of iterators.
\nconst { Readable } = require('stream');\n\nasync function * generate() {\n yield 'hello';\n yield 'streams';\n}\n\nconst readable = Readable.from(generate());\n\nreadable.on('data', (chunk) => {\n console.log(chunk);\n});\nCalling Readable.from(string) or Readable.from(buffer) will not have\nthe strings or buffers be iterated to match the other streams semantics\nfor performance reasons.
The stream module API has been designed to make it possible to easily\nimplement streams using JavaScript's prototypal inheritance model.
First, a stream developer would declare a new JavaScript class that extends one\nof the four basic stream classes (stream.Writable, stream.Readable,\nstream.Duplex, or stream.Transform), making sure they call the appropriate\nparent class constructor:
const { Writable } = require('stream');\n\nclass MyWritable extends Writable {\n constructor({ highWaterMark, ...options }) {\n super({ highWaterMark });\n // ...\n }\n}\nWhen extending streams, keep in mind what options the user\ncan and should provide before forwarding these to the base constructor. For\nexample, if the implementation makes assumptions in regard to the\nautoDestroy and emitClose options, do not allow the\nuser to override these. Be explicit about what\noptions are forwarded instead of implicitly forwarding all options.
The new stream class must then implement one or more specific methods, depending\non the type of stream being created, as detailed in the chart below:
\n| Use-case | \nClass | \nMethod(s) to implement | \n
|---|---|---|
| Reading only | \nReadable | \n_read() | \n
| Writing only | \nWritable | \n_write(), _writev(), _final() | \n
| Reading and writing | \nDuplex | \n_read(), _write(), _writev(), _final() | \n
| Operate on written data, then read the result | \nTransform | \n_transform(), _flush(), _final() | \n
The implementation code for a stream should never call the \"public\" methods\nof a stream that are intended for use by consumers (as described in the\nAPI for stream consumers section). Doing so may lead to adverse side effects\nin application code consuming the stream.
\nAvoid overriding public methods such as write(), end(), cork(),\nuncork(), read() and destroy(), or emitting internal events such\nas 'error', 'data', 'end', 'finish' and 'close' through .emit().\nDoing so can break current and future stream invariants leading to behavior\nand/or compatibility issues with other streams, stream utilities, and user\nexpectations.
For many simple cases, it is possible to construct a stream without relying on\ninheritance. This can be accomplished by directly creating instances of the\nstream.Writable, stream.Readable, stream.Duplex or stream.Transform\nobjects and passing appropriate methods as constructor options.
const { Writable } = require('stream');\n\nconst myWritable = new Writable({\n write(chunk, encoding, callback) {\n // ...\n }\n});\nThe stream.Writable class is extended to implement a Writable stream.
Custom Writable streams must call the new stream.Writable([options])\nconstructor and implement the writable._write() and/or writable._writev()\nmethod.
const { Writable } = require('stream');\n\nclass MyWritable extends Writable {\n constructor(options) {\n // Calls the stream.Writable() constructor.\n super(options);\n // ...\n }\n}\nOr, when using pre-ES6 style constructors:
\nconst { Writable } = require('stream');\nconst util = require('util');\n\nfunction MyWritable(options) {\n if (!(this instanceof MyWritable))\n return new MyWritable(options);\n Writable.call(this, options);\n}\nutil.inherits(MyWritable, Writable);\nOr, using the simplified constructor approach:
\nconst { Writable } = require('stream');\n\nconst myWritable = new Writable({\n write(chunk, encoding, callback) {\n // ...\n },\n writev(chunks, callback) {\n // ...\n }\n});\nAll Writable stream implementations must provide a\nwritable._write() and/or\nwritable._writev() method to send data to the underlying\nresource.
Transform streams provide their own implementation of the\nwritable._write().
This function MUST NOT be called by application code directly. It should be\nimplemented by child classes, and called by the internal Writable class\nmethods only.
The callback function must be called synchronously inside of\nwritable._write() or asynchronously (i.e. different tick) to signal either\nthat the write completed successfully or failed with an error.\nThe first argument passed to the callback must be the Error object if the\ncall failed or null if the write succeeded.
All calls to writable.write() that occur between the time writable._write()\nis called and the callback is called will cause the written data to be\nbuffered. When the callback is invoked, the stream might emit a 'drain'\nevent. If a stream implementation is capable of processing multiple chunks of\ndata at once, the writable._writev() method should be implemented.
If the decodeStrings property is explicitly set to false in the constructor\noptions, then chunk will remain the same object that is passed to .write(),\nand may be a string rather than a Buffer. This is to support implementations\nthat have an optimized handling for certain string data encodings. In that case,\nthe encoding argument will indicate the character encoding of the string.\nOtherwise, the encoding argument can be safely ignored.
The writable._write() method is prefixed with an underscore because it is\ninternal to the class that defines it, and should never be called directly by\nuser programs.
This function MUST NOT be called by application code directly. It should be\nimplemented by child classes, and called by the internal Writable class\nmethods only.
The writable._writev() method may be implemented in addition or alternatively\nto writable._write() in stream implementations that are capable of processing\nmultiple chunks of data at once. If implemented and if there is buffered data\nfrom previous writes, _writev() will be called instead of _write().
The writable._writev() method is prefixed with an underscore because it is\ninternal to the class that defines it, and should never be called directly by\nuser programs.
The _destroy() method is called by writable.destroy().\nIt can be overridden by child classes but it must not be called directly.
The _final() method must not be called directly. It may be implemented\nby child classes, and if so, will be called by the internal Writable\nclass methods only.
This optional function will be called before the stream closes, delaying the\n'finish' event until callback is called. This is useful to close resources\nor write buffered data before a stream ends.
Errors occurring during the processing of the writable._write(),\nwritable._writev() and writable._final() methods must be propagated\nby invoking the callback and passing the error as the first argument.\nThrowing an Error from within these methods or manually emitting an 'error'\nevent results in undefined behavior.
If a Readable stream pipes into a Writable stream when Writable emits an\nerror, the Readable stream will be unpiped.
const { Writable } = require('stream');\n\nconst myWritable = new Writable({\n write(chunk, encoding, callback) {\n if (chunk.toString().indexOf('a') >= 0) {\n callback(new Error('chunk is invalid'));\n } else {\n callback();\n }\n }\n});\nThe following illustrates a rather simplistic (and somewhat pointless) custom\nWritable stream implementation. While this specific Writable stream instance\nis not of any real particular usefulness, the example illustrates each of the\nrequired elements of a custom Writable stream instance:
const { Writable } = require('stream');\n\nclass MyWritable extends Writable {\n _write(chunk, encoding, callback) {\n if (chunk.toString().indexOf('a') >= 0) {\n callback(new Error('chunk is invalid'));\n } else {\n callback();\n }\n }\n}\nDecoding buffers is a common task, for instance, when using transformers whose\ninput is a string. This is not a trivial process when using multi-byte\ncharacters encoding, such as UTF-8. The following example shows how to decode\nmulti-byte strings using StringDecoder and Writable.
const { Writable } = require('stream');\nconst { StringDecoder } = require('string_decoder');\n\nclass StringWritable extends Writable {\n constructor(options) {\n super(options);\n this._decoder = new StringDecoder(options && options.defaultEncoding);\n this.data = '';\n }\n _write(chunk, encoding, callback) {\n if (encoding === 'buffer') {\n chunk = this._decoder.write(chunk);\n }\n this.data += chunk;\n callback();\n }\n _final(callback) {\n this.data += this._decoder.end();\n callback();\n }\n}\n\nconst euro = [[0xE2, 0x82], [0xAC]].map(Buffer.from);\nconst w = new StringWritable();\n\nw.write('currency: ');\nw.write(euro[0]);\nw.end(euro[1]);\n\nconsole.log(w.data); // currency: €\nThe stream.Readable class is extended to implement a Readable stream.
Custom Readable streams must call the new stream.Readable([options])\nconstructor and implement the readable._read() method.
const { Readable } = require('stream');\n\nclass MyReadable extends Readable {\n constructor(options) {\n // Calls the stream.Readable(options) constructor.\n super(options);\n // ...\n }\n}\nOr, when using pre-ES6 style constructors:
\nconst { Readable } = require('stream');\nconst util = require('util');\n\nfunction MyReadable(options) {\n if (!(this instanceof MyReadable))\n return new MyReadable(options);\n Readable.call(this, options);\n}\nutil.inherits(MyReadable, Readable);\nOr, using the simplified constructor approach:
\nconst { Readable } = require('stream');\n\nconst myReadable = new Readable({\n read(size) {\n // ...\n }\n});\nThis function MUST NOT be called by application code directly. It should be\nimplemented by child classes, and called by the internal Readable class\nmethods only.
All Readable stream implementations must provide an implementation of the\nreadable._read() method to fetch data from the underlying resource.
When readable._read() is called, if data is available from the resource,\nthe implementation should begin pushing that data into the read queue using the\nthis.push(dataChunk) method. _read() will be called again\nafter each call to this.push(dataChunk) once the stream is\nready to accept more data. _read() may continue reading from the resource and\npushing data until readable.push() returns false. Only when _read() is\ncalled again after it has stopped should it resume pushing additional data into\nthe queue.
Once the readable._read() method has been called, it will not be called\nagain until more data is pushed through the readable.push()\nmethod. Empty data such as empty buffers and strings will not cause\nreadable._read() to be called.
The size argument is advisory. For implementations where a \"read\" is a\nsingle operation that returns data can use the size argument to determine how\nmuch data to fetch. Other implementations may ignore this argument and simply\nprovide data whenever it becomes available. There is no need to \"wait\" until\nsize bytes are available before calling stream.push(chunk).
The readable._read() method is prefixed with an underscore because it is\ninternal to the class that defines it, and should never be called directly by\nuser programs.
The _destroy() method is called by readable.destroy().\nIt can be overridden by child classes but it must not be called directly.
When chunk is a Buffer, Uint8Array or string, the chunk of data will\nbe added to the internal queue for users of the stream to consume.\nPassing chunk as null signals the end of the stream (EOF), after which no\nmore data can be written.
When the Readable is operating in paused mode, the data added with\nreadable.push() can be read out by calling the\nreadable.read() method when the 'readable' event is\nemitted.
When the Readable is operating in flowing mode, the data added with\nreadable.push() will be delivered by emitting a 'data' event.
The readable.push() method is designed to be as flexible as possible. For\nexample, when wrapping a lower-level source that provides some form of\npause/resume mechanism, and a data callback, the low-level source can be wrapped\nby the custom Readable instance:
// `_source` is an object with readStop() and readStart() methods,\n// and an `ondata` member that gets called when it has data, and\n// an `onend` member that gets called when the data is over.\n\nclass SourceWrapper extends Readable {\n constructor(options) {\n super(options);\n\n this._source = getLowLevelSourceObject();\n\n // Every time there's data, push it into the internal buffer.\n this._source.ondata = (chunk) => {\n // If push() returns false, then stop reading from source.\n if (!this.push(chunk))\n this._source.readStop();\n };\n\n // When the source ends, push the EOF-signaling `null` chunk.\n this._source.onend = () => {\n this.push(null);\n };\n }\n // _read() will be called when the stream wants to pull more data in.\n // The advisory size argument is ignored in this case.\n _read(size) {\n this._source.readStart();\n }\n}\nThe readable.push() method is used to push the content\ninto the internal buffer. It can be driven by the readable._read() method.
For streams not operating in object mode, if the chunk parameter of\nreadable.push() is undefined, it will be treated as empty string or\nbuffer. See readable.push('') for more information.
Errors occurring during processing of the readable._read() must be\npropagated through the readable.destroy(err) method.\nThrowing an Error from within readable._read() or manually emitting an\n'error' event results in undefined behavior.
const { Readable } = require('stream');\n\nconst myReadable = new Readable({\n read(size) {\n const err = checkSomeErrorCondition();\n if (err) {\n this.destroy(err);\n } else {\n // Do some work.\n }\n }\n});\nThe following is a basic example of a Readable stream that emits the numerals\nfrom 1 to 1,000,000 in ascending order, and then ends.
const { Readable } = require('stream');\n\nclass Counter extends Readable {\n constructor(opt) {\n super(opt);\n this._max = 1000000;\n this._index = 1;\n }\n\n _read() {\n const i = this._index++;\n if (i > this._max)\n this.push(null);\n else {\n const str = String(i);\n const buf = Buffer.from(str, 'ascii');\n this.push(buf);\n }\n }\n}\nA Duplex stream is one that implements both Readable and\nWritable, such as a TCP socket connection.
Because JavaScript does not have support for multiple inheritance, the\nstream.Duplex class is extended to implement a Duplex stream (as opposed\nto extending the stream.Readable and stream.Writable classes).
The stream.Duplex class prototypically inherits from stream.Readable and\nparasitically from stream.Writable, but instanceof will work properly for\nboth base classes due to overriding Symbol.hasInstance on\nstream.Writable.
Custom Duplex streams must call the new stream.Duplex([options])\nconstructor and implement both the readable._read() and\nwritable._write() methods.
const { Duplex } = require('stream');\n\nclass MyDuplex extends Duplex {\n constructor(options) {\n super(options);\n // ...\n }\n}\nOr, when using pre-ES6 style constructors:
\nconst { Duplex } = require('stream');\nconst util = require('util');\n\nfunction MyDuplex(options) {\n if (!(this instanceof MyDuplex))\n return new MyDuplex(options);\n Duplex.call(this, options);\n}\nutil.inherits(MyDuplex, Duplex);\nOr, using the simplified constructor approach:
\nconst { Duplex } = require('stream');\n\nconst myDuplex = new Duplex({\n read(size) {\n // ...\n },\n write(chunk, encoding, callback) {\n // ...\n }\n});\nThe following illustrates a simple example of a Duplex stream that wraps a\nhypothetical lower-level source object to which data can be written, and\nfrom which data can be read, albeit using an API that is not compatible with\nNode.js streams.\nThe following illustrates a simple example of a Duplex stream that buffers\nincoming written data via the Writable interface that is read back out\nvia the Readable interface.
const { Duplex } = require('stream');\nconst kSource = Symbol('source');\n\nclass MyDuplex extends Duplex {\n constructor(source, options) {\n super(options);\n this[kSource] = source;\n }\n\n _write(chunk, encoding, callback) {\n // The underlying source only deals with strings.\n if (Buffer.isBuffer(chunk))\n chunk = chunk.toString();\n this[kSource].writeSomeData(chunk);\n callback();\n }\n\n _read(size) {\n this[kSource].fetchSomeData(size, (data, encoding) => {\n this.push(Buffer.from(data, encoding));\n });\n }\n}\nThe most important aspect of a Duplex stream is that the Readable and\nWritable sides operate independently of one another despite co-existing within\na single object instance.
For Duplex streams, objectMode can be set exclusively for either the\nReadable or Writable side using the readableObjectMode and\nwritableObjectMode options respectively.
In the following example, for instance, a new Transform stream (which is a\ntype of Duplex stream) is created that has an object mode Writable side\nthat accepts JavaScript numbers that are converted to hexadecimal strings on\nthe Readable side.
const { Transform } = require('stream');\n\n// All Transform streams are also Duplex Streams.\nconst myTransform = new Transform({\n writableObjectMode: true,\n\n transform(chunk, encoding, callback) {\n // Coerce the chunk to a number if necessary.\n chunk |= 0;\n\n // Transform the chunk into something else.\n const data = chunk.toString(16);\n\n // Push the data onto the readable queue.\n callback(null, '0'.repeat(data.length % 2) + data);\n }\n});\n\nmyTransform.setEncoding('ascii');\nmyTransform.on('data', (chunk) => console.log(chunk));\n\nmyTransform.write(1);\n// Prints: 01\nmyTransform.write(10);\n// Prints: 0a\nmyTransform.write(100);\n// Prints: 64\nA Transform stream is a Duplex stream where the output is computed\nin some way from the input. Examples include zlib streams or crypto\nstreams that compress, encrypt, or decrypt data.
There is no requirement that the output be the same size as the input, the same\nnumber of chunks, or arrive at the same time. For example, a Hash stream will\nonly ever have a single chunk of output which is provided when the input is\nended. A zlib stream will produce output that is either much smaller or much\nlarger than its input.
The stream.Transform class is extended to implement a Transform stream.
The stream.Transform class prototypically inherits from stream.Duplex and\nimplements its own versions of the writable._write() and\nreadable._read() methods. Custom Transform implementations must\nimplement the transform._transform() method and may\nalso implement the transform._flush() method.
Care must be taken when using Transform streams in that data written to the\nstream can cause the Writable side of the stream to become paused if the\noutput on the Readable side is not consumed.
const { Transform } = require('stream');\n\nclass MyTransform extends Transform {\n constructor(options) {\n super(options);\n // ...\n }\n}\nOr, when using pre-ES6 style constructors:
\nconst { Transform } = require('stream');\nconst util = require('util');\n\nfunction MyTransform(options) {\n if (!(this instanceof MyTransform))\n return new MyTransform(options);\n Transform.call(this, options);\n}\nutil.inherits(MyTransform, Transform);\nOr, using the simplified constructor approach:
\nconst { Transform } = require('stream');\n\nconst myTransform = new Transform({\n transform(chunk, encoding, callback) {\n // ...\n }\n});\nThe 'end' event is from the stream.Readable class. The 'end' event is\nemitted after all data has been output, which occurs after the callback in\ntransform._flush() has been called. In the case of an error,\n'end' should not be emitted.
The 'finish' event is from the stream.Writable class. The 'finish'\nevent is emitted after stream.end() is called and all chunks\nhave been processed by stream._transform(). In the case\nof an error, 'finish' should not be emitted.
This function MUST NOT be called by application code directly. It should be\nimplemented by child classes, and called by the internal Readable class\nmethods only.
In some cases, a transform operation may need to emit an additional bit of\ndata at the end of the stream. For example, a zlib compression stream will\nstore an amount of internal state used to optimally compress the output. When\nthe stream ends, however, that additional data needs to be flushed so that the\ncompressed data will be complete.
Custom Transform implementations may implement the transform._flush()\nmethod. This will be called when there is no more written data to be consumed,\nbut before the 'end' event is emitted signaling the end of the\nReadable stream.
Within the transform._flush() implementation, the transform.push() method\nmay be called zero or more times, as appropriate. The callback function must\nbe called when the flush operation is complete.
The transform._flush() method is prefixed with an underscore because it is\ninternal to the class that defines it, and should never be called directly by\nuser programs.
This function MUST NOT be called by application code directly. It should be\nimplemented by child classes, and called by the internal Readable class\nmethods only.
All Transform stream implementations must provide a _transform()\nmethod to accept input and produce output. The transform._transform()\nimplementation handles the bytes being written, computes an output, then passes\nthat output off to the readable portion using the transform.push() method.
The transform.push() method may be called zero or more times to generate\noutput from a single input chunk, depending on how much is to be output\nas a result of the chunk.
It is possible that no output is generated from any given chunk of input data.
\nThe callback function must be called only when the current chunk is completely\nconsumed. The first argument passed to the callback must be an Error object\nif an error occurred while processing the input or null otherwise. If a second\nargument is passed to the callback, it will be forwarded on to the\ntransform.push() method. In other words, the following are equivalent:
transform.prototype._transform = function(data, encoding, callback) {\n this.push(data);\n callback();\n};\n\ntransform.prototype._transform = function(data, encoding, callback) {\n callback(null, data);\n};\nThe transform._transform() method is prefixed with an underscore because it\nis internal to the class that defines it, and should never be called directly by\nuser programs.
transform._transform() is never called in parallel; streams implement a\nqueue mechanism, and to receive the next chunk, callback must be\ncalled, either synchronously or asynchronously.
The stream.PassThrough class is a trivial implementation of a Transform\nstream that simply passes the input bytes across to the output. Its purpose is\nprimarily for examples and testing, but there are some use cases where\nstream.PassThrough is useful as a building block for novel sorts of streams.
With the support of async generators and iterators in JavaScript, async\ngenerators are effectively a first-class language-level stream construct at\nthis point.
\nSome common interop cases of using Node.js streams with async generators\nand async iterators are provided below.
", "modules": [ { "textRaw": "Consuming readable streams with async iterators", "name": "consuming_readable_streams_with_async_iterators", "desc": "(async function() {\n for await (const chunk of readable) {\n console.log(chunk);\n }\n})();\nAsync iterators register a permanent error handler on the stream to prevent any\nunhandled post-destroy errors.
", "type": "module", "displayName": "Consuming readable streams with async iterators" }, { "textRaw": "Creating readable streams with async generators", "name": "creating_readable_streams_with_async_generators", "desc": "We can construct a Node.js readable stream from an asynchronous generator\nusing the Readable.from() utility method:
const { Readable } = require('stream');\n\nasync function * generate() {\n yield 'a';\n yield 'b';\n yield 'c';\n}\n\nconst readable = Readable.from(generate());\n\nreadable.on('data', (chunk) => {\n console.log(chunk);\n});\nWhen writing to a writable stream from an async iterator, ensure correct\nhandling of backpressure and errors. stream.pipeline() abstracts away\nthe handling of backpressure and backpressure-related errors:
const { pipeline } = require('stream');\nconst util = require('util');\nconst fs = require('fs');\n\nconst writable = fs.createWriteStream('./file');\n\n// Callback Pattern\npipeline(iterator, writable, (err, value) => {\n if (err) {\n console.error(err);\n } else {\n console.log(value, 'value returned');\n }\n});\n\n// Promise Pattern\nconst pipelinePromise = util.promisify(pipeline);\npipelinePromise(iterator, writable)\n .then((value) => {\n console.log(value, 'value returned');\n })\n .catch(console.error);\nPrior to Node.js 0.10, the Readable stream interface was simpler, but also\nless powerful and less useful.
stream.read() method,\n'data' events would begin emitting immediately. Applications that\nwould need to perform some amount of work to decide how to handle data\nwere required to store read data into buffers so the data would not be lost.stream.pause() method was advisory, rather than\nguaranteed. This meant that it was still necessary to be prepared to receive\n'data' events even when the stream was in a paused state.In Node.js 0.10, the Readable class was added. For backward\ncompatibility with older Node.js programs, Readable streams switch into\n\"flowing mode\" when a 'data' event handler is added, or when the\nstream.resume() method is called. The effect is that, even\nwhen not using the new stream.read() method and\n'readable' event, it is no longer necessary to worry about losing\n'data' chunks.
While most applications will continue to function normally, this introduces an\nedge case in the following conditions:
\n'data' event listener is added.stream.resume() method is never called.For example, consider the following code:
\n// WARNING! BROKEN!\nnet.createServer((socket) => {\n\n // We add an 'end' listener, but never consume the data.\n socket.on('end', () => {\n // It will never get here.\n socket.end('The message was received but was not processed.\\n');\n });\n\n}).listen(1337);\nPrior to Node.js 0.10, the incoming message data would be simply discarded.\nHowever, in Node.js 0.10 and beyond, the socket remains paused forever.
\nThe workaround in this situation is to call the\nstream.resume() method to begin the flow of data:
// Workaround.\nnet.createServer((socket) => {\n socket.on('end', () => {\n socket.end('The message was received but was not processed.\\n');\n });\n\n // Start the flow of data, discarding it.\n socket.resume();\n}).listen(1337);\nIn addition to new Readable streams switching into flowing mode,\npre-0.10 style streams can be wrapped in a Readable class using the\nreadable.wrap() method.
The use of readable.setEncoding() will change the behavior of how the\nhighWaterMark operates in non-object mode.
Typically, the size of the current buffer is measured against the\nhighWaterMark in bytes. However, after setEncoding() is called, the\ncomparison function will begin to measure the buffer's size in characters.
This is not a problem in common cases with latin1 or ascii. But it is\nadvised to be mindful about this behavior when working with strings that could\ncontain multi-byte characters.
There are some cases where it is necessary to trigger a refresh of the\nunderlying readable stream mechanisms, without actually consuming any\ndata. In such cases, it is possible to call readable.read(0), which will\nalways return null.
If the internal read buffer is below the highWaterMark, and the\nstream is not currently reading, then calling stream.read(0) will trigger\na low-level stream._read() call.
While most applications will almost never need to do this, there are\nsituations within Node.js where this is done, particularly in the\nReadable stream class internals.
Use of readable.push('') is not recommended.
Pushing a zero-byte string, Buffer or Uint8Array to a stream that is not in\nobject mode has an interesting side effect. Because it is a call to\nreadable.push(), the call will end the reading process.\nHowever, because the argument is an empty string, no data is added to the\nreadable buffer so there is nothing for a user to consume.