Node.js MongoDB Driver API

External: Readable

Readable

Namespace provided by the browser.

Methods

pause(){null}

lib/cursor.js, line 1116

This method will cause a stream in flowing-mode to stop emitting data events. Any data that becomes available will remain in the internal buffer.

pipe(destination, options){null}

lib/cursor.js, line 1122

This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream.

Name Type Description
destination Writable

The destination for writing data
options object optional

Pipe options

read(size){String|Buffer|null}

lib/cursor.js, line 1096

The read() method pulls some data out of the internal buffer and returns it. If there is no data available, then it will return null.

Name Type Description
size number

Optional argument to specify how much data to read.

resume(){null}

lib/cursor.js, line 1110

This method will cause the readable stream to resume emitting data events.

setEncoding(encoding){null}

lib/cursor.js, line 1103

Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects.

Name Type Description
encoding string

The encoding to use.

unpipe(destination){null}

lib/cursor.js, line 1130

This method will remove the hooks set up for a previous pipe() call.

Name Type Description
destination Writable optional

The destination for writing data

unshift(chunk){null}

lib/cursor.js, line 1137

This is useful in certain cases where a stream is being consumed by a parser, which needs to "un-consume" some data that it has optimistically pulled out of the source, so that the stream can be passed on to some other party.

Name Type Description
chunk Buffer | string

Chunk of data to unshift onto the read queue.

wrap(stream){null}

lib/cursor.js, line 1144

Versions of Node prior to v0.10 had streams that did not implement the entire Streams API as it is today. (See "Compatibility" below for more information.)

Name Type Description
stream Stream

An "old style" readable stream.

Readable

Namespace provided by the browser.

Methods

pause(){null}

lib/cursor.js, line 1116

This method will cause a stream in flowing-mode to stop emitting data events. Any data that becomes available will remain in the internal buffer.

pipe(destination, options){null}

lib/cursor.js, line 1122

This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream.

Name Type Description
destination Writable

The destination for writing data
options object optional

Pipe options

read(size){String|Buffer|null}

lib/cursor.js, line 1096

The read() method pulls some data out of the internal buffer and returns it. If there is no data available, then it will return null.

Name Type Description
size number

Optional argument to specify how much data to read.

resume(){null}

lib/cursor.js, line 1110

This method will cause the readable stream to resume emitting data events.

setEncoding(encoding){null}

lib/cursor.js, line 1103

Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects.

Name Type Description
encoding string

The encoding to use.

unpipe(destination){null}

lib/cursor.js, line 1130

This method will remove the hooks set up for a previous pipe() call.

Name Type Description
destination Writable optional

The destination for writing data

unshift(chunk){null}

lib/cursor.js, line 1137

This is useful in certain cases where a stream is being consumed by a parser, which needs to "un-consume" some data that it has optimistically pulled out of the source, so that the stream can be passed on to some other party.

Name Type Description
chunk Buffer | string

Chunk of data to unshift onto the read queue.

wrap(stream){null}

lib/cursor.js, line 1144

Versions of Node prior to v0.10 had streams that did not implement the entire Streams API as it is today. (See "Compatibility" below for more information.)

Name Type Description
stream Stream

An "old style" readable stream.

Readable

Namespace provided by the code module

Methods

pause(){null}

lib/cursor.js, line 1116

This method will cause a stream in flowing-mode to stop emitting data events. Any data that becomes available will remain in the internal buffer.

pipe(destination, options){null}

lib/cursor.js, line 1122

This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream.

Name Type Description
destination Writable

The destination for writing data
options object optional

Pipe options

read(size){String|Buffer|null}

lib/cursor.js, line 1096

The read() method pulls some data out of the internal buffer and returns it. If there is no data available, then it will return null.

Name Type Description
size number

Optional argument to specify how much data to read.

resume(){null}

lib/cursor.js, line 1110

This method will cause the readable stream to resume emitting data events.

setEncoding(encoding){null}

lib/cursor.js, line 1103

Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects.

Name Type Description
encoding string

The encoding to use.

unpipe(destination){null}

lib/cursor.js, line 1130

This method will remove the hooks set up for a previous pipe() call.

Name Type Description
destination Writable optional

The destination for writing data

unshift(chunk){null}

lib/cursor.js, line 1137

This is useful in certain cases where a stream is being consumed by a parser, which needs to "un-consume" some data that it has optimistically pulled out of the source, so that the stream can be passed on to some other party.

Name Type Description
chunk Buffer | string

Chunk of data to unshift onto the read queue.

wrap(stream){null}

lib/cursor.js, line 1144

Versions of Node prior to v0.10 had streams that did not implement the entire Streams API as it is today. (See "Compatibility" below for more information.)

Name Type Description
stream Stream

An "old style" readable stream.