# s3-upload-dir

> Upload Directory on S3

Latest version **0.1.0** (published 2016-12-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install s3-upload-dir
pnpm add s3-upload-dir
yarn add s3-upload-dir
bun add s3-upload-dir
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2016-12-18 |
| First published | 2016-12-18 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Alair J. Tavares] |
| Maintainers | alairjt |
| Keywords | s3, upload, deploy, angular, directory |

## Links

- npm: https://www.npmjs.com/package/s3-upload-dir
- Repository: https://github.com/alairjt/s3-upload-dir
- Homepage: https://github.com/alairjt/s3-upload-dir#readme
- Issues: https://github.com/alairjt/s3-upload-dir/issues
- npm.io page: https://npm.io/package/s3-upload-dir

## Dependencies (2)

- [s3](https://npm.io/package/s3.md) ^4.4.0
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.7.15

## Recent versions

- 0.1.0 (latest) — 2016-12-18

## README

# S3-UPLOAD-DIR
Upload Directory to AWS S3

### Install

```ssh
npm install s3-upload-dir --save
```

### How To Use

```javascript
var s3 = require('s3-upload-dir');

var params = {
    localDir: "DIR_NAME",
    s3Params: {
        Bucket: "YOUR_BUCKET_NAME"
    }
};

var uploader = s3.uploadDir(params);

uploader.on('error', function (err) {
    console.error("unable to upload:", err.stack);
});

uploader.on('progress', function () {
    console.log("progress", uploader.progressMd5Amount,
            uploader.progressAmount, uploader.progressTotal);
});

uploader.on('end', function () {
    console.log("done uploading");
    exit;
});

```

---
_Source: https://npm.io/package/s3-upload-dir · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._