Interface NoFilterOptions

Hierarchy

  • NoFilterOptions

Properties

allowHalfOpen: boolean

If set to false, then the stream will automatically end the writable side when the readable side ends.

autoDestroy: boolean

Whether this stream should automatically call .destroy() on itself after ending.

decodeStrings: boolean

Whether or not to decode strings into Buffers before passing them to _write().

defaultEncoding: BufferEncoding

The default encoding that is used when no encoding is specified as an argument to stream.write().

emitClose: boolean

Whether or not the stream should emit 'close' after it has been destroyed.

encoding: BufferEncoding

If specified, then buffers will be decoded to strings using the specified encoding.

highWaterMark: number

The 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.

input: string | Buffer

Input source data.

inputEncoding: BufferEncoding

Encoding name for input, ignored if input is not a String.

objectMode: boolean

Whether 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.

readError: boolean

If true, when a read() underflows, throw an error.

readableHighWaterMark: number

Sets highWaterMark for the readable side of the stream. Has no effect if highWaterMark is provided.

readableObjectMode: boolean

Sets objectMode for readable side of the stream. Has no effect if objectMode is true.

watchPipe: boolean

Whether to watch for 'pipe' events, setting this stream's objectMode based on the objectMode of the input stream.

writableHighWaterMark: number

Sets highWaterMark for the writable side of the stream. Has no effect if highWaterMark is provided.

writableObjectMode: boolean

Sets objectMode for writable side of the stream. Has no effect if objectMode is true.

Generated using TypeDoc