Class: GridFSBucketReadStream

Methods

_read()

lib/gridfs-stream/download.js, line 87

Reads from the cursor and pushes to the stream.

abort(callback)

lib/gridfs-stream/download.js, line 139

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.

Name	Type	Description
callback	GridFSBucket~errorCallback	optional called when the cursor is successfully closed or an error occurred.

Fires:

• GridFSBucketWriteStream#event:close
• GridFSBucketWriteStream#event:end

Example

// Calling abort() on a GridFSBucketReadStream

var MongoClient = require('mongodb').MongoClient,
  test = require('assert');
MongoClient.connect('mongodb://localhost:27017/test', function(err, db) {
  var bucket = new GridFSBucket(db,
    { bucketName: 'gridfsdestroy', chunkSizeBytes: 10 });
  var readStream = fs.createReadStream('./LICENSE');
  var uploadStream = bucket.openUploadStream('test.dat');

  var id = uploadStream.id;

  // Wait for stream to finish
  uploadStream.once('finish', function() {
    var id = uploadStream.id;
    var downloadStream = bucket.openDownloadStream(id);
    var done = {};
    downloadStream.on('data', function() {
      test.ok(false);
    });
    downloadStream.on('error', function() {
      test.ok(false);
    });
    downloadStream.on('end', function() {
      test.equal(downloadStream.s.cursor, null);
      if (done.close) {
      }
      done.end = true;
    });
    downloadStream.on('close', function() {
      if (done.end) {
      }
      done.close = true;
    });
    downloadStream.abort(function(error) {
      test.equal(error, null);
    });
  });

  readStream.pipe(uploadStream);

end(end){GridFSBucketReadStream}

lib/gridfs-stream/download.js, line 122

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'))

Name	Type	Description
end	Number	Offset in bytes to stop reading at

start(start){GridFSBucketReadStream}

lib/gridfs-stream/download.js, line 107

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'))

Name	Type	Description
start	Number	Offset in bytes to start reading at

Events

close

lib/gridfs-stream/download.js, line 75

Fired when the stream is exhausted and the underlying cursor is killed

Type:

• object

data

lib/gridfs-stream/download.js, line 61

Emitted when a chunk of data is available to be consumed.

Type:

• object

end

lib/gridfs-stream/download.js, line 68

Fired when the stream is exhausted (no more data events).

Type:

• object

error

lib/gridfs-stream/download.js, line 46

An error occurred

Type:

• Error

file

lib/gridfs-stream/download.js, line 53

Fires when the stream loaded the file document corresponding to the
provided id.

Type:

• object