skipper-disk

Disk Blob Adapter

   

Local filesystem adapter for receiving streams of file streams. Particularly useful for streaming multipart file uploads via Skipper.

This module is bundled as the default blob adapter in Skipper, and consequently Sails.

========================================

Installation

$ npm install skipper-disk --save

========================================

Usage

First instantiate a blob adapter (blobAdapter):

var blobAdapter = require('skipper-disk')();

Build a receiver (receiving):

var receiving = blobAdapter.receive();

Then stream file(s) from a particular field (req.file('foo')):

req.file('foo').upload(receiving, function (err, filesUploaded) {
  // ...
});

========================================

Options

All options may be passed either into the blob adapter's factory method:

var blobAdapter = require('skipper-disk')({
  // These options will be applied unless overridden.
});

Or directly into a receiver:

var receiving = blobAdapter.receive({
  // Options will be applied only to this particular receiver.
});

Option	Type	Details
dirname	((string))	The path to the directory on disk where file uploads should be streamed. May be specified as an absolute path (e.g. /Users/mikermcneil/foo) or a relative path from the current working directory. Defaults to ".tmp/uploads/"
saveAs()	((function))	An optional function that can be used to define the logic for naming files. For example: function (file) {return Math.random()+file.name;} }); By default, the filename of the uploaded file is used, including the extension (e.g. "Screen Shot 2014-05-06 at 4.44.02 PM.jpg". If a file already exists at dirname with the same name, it will be overridden.

========================================

Advanced Usage

upstream.pipe(receiving)

As an alternative to the upload() method, you can pipe an incoming upstream returned from req.file() (a Readable stream of Readable binary streams) directly to the receiver (a Writable stream for Upstreams.)

req.file('foo').pipe(receiving);

There is no performance benefit to using .pipe() instead of .upload()-- they both use streams2. The .pipe() method is available merely as a matter of flexibility/chainability. Be aware that .upload() handles the error and finish events for you; if you choose to use .pipe(), you will of course need to listen for these events manually:

req.file('foo')
.on('error', function onError() { ... })
.on('finish', function onSuccess() { ... })
.pipe(receiving)

========================================

Contribute

See CONTRIBUTING.md.

========================================

License

MIT © 2013, 2014-

Mike McNeil, Balderdash & contributors

See LICENSE.md.

This module is part of the Sails framework, and is free and open-source under the MIT License.