Optional
allowOptional
autoWhether this stream should automatically call .destroy() on itself after ending.
Optional
decodeWhether or not to decode strings into Buffers before passing them to _write().
Optional
defaultThe default encoding that is used when no encoding is specified as an argument to stream.write().
Optional
emitWhether or not the stream should emit 'close' after it has been destroyed.
Optional
encodingIf specified, then buffers will be decoded to strings using the specified encoding.
Optional
highThe maximum number of bytes to store in the internal buffer before ceasing to read from the underlying resource. Default=16kb, or 16 for objectMode streams.
Optional
inputInput source data.
Optional
inputEncoding name for input, ignored if input is not a String.
Optional
objectWhether this stream should behave as a stream of objects. Meaning that stream.read(n) returns a single value instead of a Buffer of size n.
Optional
readableSets highWaterMark for the readable side of the stream. Has no effect if highWaterMark is provided.
Optional
readableSets objectMode for readable side of the stream. Has no effect if objectMode is true.
Optional
readIf true, when a read() underflows, throw an error.
Optional
watchWhether to watch for 'pipe' events, setting this stream's objectMode based on the objectMode of the input stream.
Optional
writableSets highWaterMark for the writable side of the stream. Has no effect if highWaterMark is provided.
Optional
writableSets objectMode for writable side of the stream. Has no effect if objectMode is true.
If set to false, then the stream will automatically end the writable side when the readable side ends.