A readable stream that enables you to read buffers from GridFS.
Do not instantiate this class directly. Use openDownloadStream() instead.
chunks Collection
Handle for chunks collection
files Collection
Handle for files collection
readPreference Object
The read preference to use
filter Object
The query to use to find the file document
options Object optional
Optional settings.
Name Type Descriptionsort Number optional
Optional sort for the file find query
skip Number optional
Optional skip for the file find query
start Number optional
Optional 0-based offset in bytes to start streaming from
end Number optional
Optional 0-based offset in bytes to stop streaming before
Marks this stream as aborted (will never push another data event)
and kills the underlying cursor. Will emit the 'end' event, and then
the 'close' event once the cursor is successfully killed.
callback GridFSBucket~errorCallback optional
called when the cursor is successfully closed or an error occurred.
Sets the 0-based offset in bytes to start streaming from. Throws
an error if this stream has entered flowing mode
(e.g. if you've already called on('data'))
end Number
Offset in bytes to stop reading at
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.
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 Descriptiondestination Writable
The destination for writing data
options object optional
Pipe options
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 Descriptionsize number
Optional argument to specify how much data to read.
This method will cause the readable stream to resume emitting data events.
Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects.
Name Type Descriptionencoding string
The encoding to use.
Sets the 0-based offset in bytes to start streaming from. Throws
an error if this stream has entered flowing mode
(e.g. if you've already called on('data'))
start Number
Offset in bytes to start reading at
This method will remove the hooks set up for a previous pipe() call.
Name Type Descriptiondestination Writable optional
The destination for writing data
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 Descriptionchunk Buffer | string
Chunk of data to unshift onto the read queue.
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 Descriptionstream Stream
An "old style" readable stream.
Fired when the stream is exhausted and the underlying cursor is killed
Type:Emitted when a chunk of data is available to be consumed.
Type:Fired when the stream is exhausted (no more data events).
Type:An error occurred
Type:Fires when the stream loaded the file document corresponding to the
provided id.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4