Package Exports
- s3-stream-upload
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (s3-stream-upload) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
s3-stream-upload
A writable stream which uploads to Amazon S3 using the multipart file upload API.
Inspired by s3-upload-stream.
Install
npm install s3-stream-uploadUsage
var UploadStream = require("s3-stream-upload");
var S3 = require("aws-sdk").S3;
var key = "file.mp3";
var s3 = new S3();
fs.readFileStream(__dirname + "/file.mp3")
.pipe(UploadStream(s3, { Bucket: "my-bucket", Key: key }))
.on("error", function (err) {
console.error(err);
})
.on("finish", function () {
console.log("File uploaded!");
});API
UploadStream(s3, s3Config, config)
Creates and returns a WritableStream for uploading to S3. Takes an S3 instance, and a s3Config object, which takes the same options as S3.createMultipartUpload. Additional, non-S3 config options may be set on config, listed below:
concurrentHow many chunks can be sent to S3 concurrently.1by default.
Events
chunk-uploaded- Emitted when a MPU chunk has been uploaded to S3, with the number of chunks uploaded at this point.- All WritableStream events.
Properties
bytesWritten- Like fs.WriteStream, bytes uploaded to S3 currently.
Testing
To run unit tests, run:
npm testLicense
MIT License, Copyright (c) 2014 Jordan Santell