Class: ReadableFileStream

ReadableFileStream(options)

Creates a readable stream of a file from a Sbucket

Constructor

new ReadableFileStream(options)

Parameters:
Name Type Description
options Object
Properties
Name Type Description
sBucket Sbucket
fileKey String
Source:

Methods

destroy(callback)

Destroys and aborts any reads for this stream
Parameters:
Name Type Description
callback Sbucket~unlinkCallback
Source:

Events

data

Triggered when a data is pushed through the stream
Parameters:
Name Type Description
bytes Buffer
Source:

end

Triggered when no more data is available
Source:

error

Triggered if an error occurs
Parameters:
Name Type Description
error Error
Source:

readable

Triggered when data is available to read
Source: