class ReadStream

Is true after readable.destroy() has been called.

See also:

• https://nodejs.org/api/stream.html#stream_readable_destroyed

Terminal read streams (i.e. process.stdin) have this property set to true. It is false for any other read streams.

See also:

• https://nodejs.org/api/tty.html#tty_readstream_istty

Is true if it is safe to call readable.read().

See also:

• https://nodejs.org/api/stream.html#stream_readable_readable

Getter for the property encoding of a given Readable stream. The encoding property can be set using the readable.setEncoding() method.

See also:

• https://nodejs.org/api/stream.html#stream_readable_readableencoding

Becomes true when 'end' event is emitted.

See also:

• https://nodejs.org/api/stream.html#stream_readable_readableended

Returns the value of highWaterMark passed when constructing this Readable.

See also:

• https://nodejs.org/api/stream.html#stream_readable_readablehighwatermark

This property contains the number of bytes (or objects) in the queue ready to be read. The value provides introspection data regarding the status of the highWaterMark.

See also:

• https://nodejs.org/api/stream.html#stream_readable_readablelength

Getter for the property objectMode of a given Readable stream.

See also:

• https://nodejs.org/api/stream.html#stream_readable_readableobjectmode

Destroy the stream. Optionally emit an 'error' event, and emit a 'close' event unless emitClose is set in false. After this call, the readable stream will release any internal resources and subsequent calls to push() will be ignored. Implementors should not override this method, but instead implement readable._destroy().

See also:

• https://nodejs.org/api/stream.html#stream_readable_destroy_error

The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.pipe() method. In most typical cases, there will be no reason to use this method directly.

See also:

• https://nodejs.org/api/stream.html#stream_readable_ispaused

The readable.pause() method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

See also:

• https://nodejs.org/api/stream.html#stream_readable_pause

The readable.pipe() method attaches a Writable stream to the readable, causing it to switch automatically into flowing mode and push all of its data to the attached Writable. The flow of data will be automatically managed so that the destination Writable stream is not overwhelmed by a faster Readable stream.

See also:

• https://nodejs.org/api/stream.html#stream_readable_pipe_destination_options

The readable.read() method pulls some data out of the internal buffer and returns it. If no data available to be read, null is returned. By default, the data will be returned as a Buffer object unless an encoding has been specified using the readable.setEncoding() method or the stream is operating in object mode.

See also:

• https://nodejs.org/api/stream.html#stream_readable_read_size

The readable.resume() method causes an explicitly paused Readable stream to resume emitting 'data' events, switching the stream into flowing mode.

See also:

• https://nodejs.org/api/stream.html#stream_readable_resume

The readable.setEncoding() method sets the character encoding for data read from the Readable stream.

See also:

• https://nodejs.org/api/stream.html#stream_readable_setencoding_encoding

The readable.unpipe() method detaches a Writable stream previously attached using the stream.pipe() method.

See also:

• https://nodejs.org/api/stream.html#stream_readable_unpipe_destination

Passing chunk as null signals the end of the stream (EOF), after which no more data can be written.

See also:

• https://nodejs.org/api/stream.html#stream_readable_unshift_chunk_encoding

Prior to Node.js 0.10, streams did not implement the entire stream module API as it is currently defined. (See Compatibility for more information.)

See also:

• https://nodejs.org/api/stream.html#stream_readable_wrap_stream

Alias for emitter.on(eventName, listener).

See also:

• https://nodejs.org/api/events.html#events_emitter_addlistener_eventname_listener

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

See also:

• https://nodejs.org/api/events.html#events_emitter_emit_eventname_args

Returns an array listing the events for which the emitter has registered listeners. The values in the array will be strings or Symbols.

See also:

• https://nodejs.org/api/events.html#events_emitter_eventnames

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

See also:

• https://nodejs.org/api/events.html#events_emitter_getmaxlisteners

Returns the number of listeners listening to the event named eventName.

See also:

• https://nodejs.org/api/events.html#events_emitter_listenercount_eventname

Returns a copy of the array of listeners for the event named eventName.

See also:

• https://nodejs.org/api/events.html#events_emitter_listeners_eventname

Alias for emitter.removeListener().

See also:

• https://nodejs.org/api/events.html#events_emitter_off_eventname_listener

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

See also:

• https://nodejs.org/api/events.html#events_emitter_on_eventname_listener

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

See also:

• https://nodejs.org/api/events.html#events_emitter_once_eventname_listener

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

See also:

• https://nodejs.org/api/events.html#events_emitter_prependlistener_eventname_listener

Adds a one-time listener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

See also:

• https://nodejs.org/api/events.html#events_emitter_prependoncelistener_eventname_listener

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

See also:

• https://nodejs.org/api/events.html#events_emitter_rawlisteners_eventname

Removes all listeners, or those of the specified eventName.

See also:

• https://nodejs.org/api/events.html#events_emitter_removealllisteners_eventname

Removes the specified listener from the listener array for the event named eventName.

See also:

• https://nodejs.org/api/events.html#events_emitter_removelistener_eventname_listener

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. Obviously, not all events should be limited to just 10 listeners. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

See also:

• https://nodejs.org/api/events.html#events_emitter_setmaxlisteners_n