1.0.3 • Published 3 years ago

upload-objects v1.0.3

Weekly downloads
2
License
MIT
Repository
-
Last release
3 years ago

upload-objects

Upload objects to cloud object hosting solutions like AWS S3.

It will upload them incrementally with the provided prefix to the hosting solution.

These object will be publicly available

Planning to add the support to extend the base uploading capabilities.

TODO

  • Add tests

  • Add the ability to extend

  • Improve documentation

Install

Install with npm:

$ npm install --save upload-objects

Usage

Programmatically uploading the objects.

import S3Uploader from 'S3Uploader';

const options: S3UploaderOptions = {
    bucketName: bucketname,
    objectPrefix: directoryprefix,
    uploadFileDirectory: uploadfilepath,
};

const s3 = new S3Uploader(options);

s3.startUpload();

Using the CLI

$ node src/s3_filer_uploader.js --bucketname= --directoryprefix= --entryfile=

About

Contributing

Pull requests are always welcome.

For bugs and feature requests, please create an issue.

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API.

You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Basel Ahmed

License

Copyright © 2020, Basel Ahmed. Released under the MIT License.