OptionalallowOptionalautoWhether this stream should automatically call .destroy() on itself after ending.
OptionalbigBy default, if you try to
readFull() or waitFor() more bytes than fit in the readable side's
highWaterMark, that highWaterMark will be permanently raised to fit the
amount requested. If this option is true, an error will be thrown instead.
OptionaldecodeWhether or not to decode strings into Buffers before passing them to _write().
OptionaldefaultThe default encoding that is used when no encoding is specified as an argument to stream.write().
OptionalemitWhether or not the stream should emit 'close' after it has been destroyed.
OptionalencodingIf specified, then buffers will be decoded to strings using the specified encoding.
OptionalhighThe 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.
OptionalinputInput source data.
OptionalinputEncoding name for input, ignored if input is not a String.
OptionalobjectWhether 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.
OptionalreadableSets highWaterMark for the readable side of the stream. Has no effect if highWaterMark is provided.
OptionalreadableSets objectMode for readable side of the stream. Has no effect if objectMode is true.
OptionalreadIf true, when a read() underflows, throw an error.
OptionalsignalOptionalwatchWhether to watch for 'pipe' events, setting this stream's objectMode based on the objectMode of the input stream.
OptionalwritableSets highWaterMark for the writable side of the stream. Has no effect if highWaterMark is provided.
OptionalwritableSets 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.