unzip-to-s3

Unzip files directly to Amazon S3 using streams.

Showing:

Popularity

Downloads/wk

151

GitHub Stars

12

Maintenance

Last Commit

6yrs ago

Contributors

2

Package

Dependencies

4

Size (min+gzip)

64.5KB

License

BSD-2-Clause

Type Definitions

Tree-Shakeable

No?

Categories

Readme

unzip-to-s3

Unzip files directly to Amazon S3 using streams.

Install

npm install unzip-to-s3 --save

Usage

var fs = require('fs');
var unzipToS3 = require('unzip-to-s3');

// Create the S3 client
var bucketUpload = unzipToS3.createClient({
  key: 'some_key',        // required
  secret: 'some_secret',  // required
  bucket: 'some_bucket',  // required
  path: 'some/path'   // optional
});

// Create the zip read stream
var zipStream = fs.createReadStream('path/to/some/file.zip');

// Unzip and upload
bucketUpload(zipStream).on('data', function (file) {
  // "file" is the file stream and object that was inflated
  // from the zip file
}).pipe(process.stdout);

Client Options

  • key - your AWS key
  • secret - your AWS secret
  • bucket - your S3 bucket
  • path - the path to store your objects on S3

unzip-to-s3 uses Knox underneath, so refer to their Client Creation Options for all client options.

Run tests

npm install
npm test

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial