# gulp-s3

> Uploads files to s3

Latest version **0.11.0** (published 2017-01-31) · 0 weekly downloads

## Install

```sh
npm install gulp-s3
pnpm add gulp-s3
yarn add gulp-s3
bun add gulp-s3
```

## 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.11.0 |
| Published | 2017-01-31 |
| First published | 2014-01-29 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.8.0 |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 100 |
| Author | Nicholas Kostelnik |
| Maintainers | nkostelnik |
| Keywords | gulpplugin, gulp, s3 |

## Links

- npm: https://www.npmjs.com/package/gulp-s3
- Repository: https://github.com/nitaigao/gulp-s3
- Issues: https://github.com/nitaigao/gulp-s3/issues
- npm.io page: https://npm.io/package/gulp-s3

## Dependencies (5)

- [knox](https://npm.io/package/knox.md)
- [mime](https://npm.io/package/mime.md) ~1.2.11
- [async](https://npm.io/package/async.md)
- [gulp-util](https://npm.io/package/gulp-util.md) ~2.2.6
- [event-stream](https://npm.io/package/event-stream.md) *

## Recent versions

- 0.11.0 (latest) — 2017-01-31
- 0.10.0 — 2017-01-26
- 0.9.0 — 2017-01-26
- 0.8.0 — 2017-01-26
- 0.7.0 — 2017-01-25
- 0.6.0 — 2017-01-25
- 0.5.1 — 2017-01-25
- 0.5.0 — 2017-01-25
- 0.3.0 — 2014-05-28
- 0.2.0 — 2014-05-02
- 0.1.1 — 2014-02-22
- 0.1.0 — 2014-01-29

## README

# gulp-s3 [![NPM version][npm-image]][npm-url]

> s3 plugin for [gulp](https://github.com/wearefractal/gulp)

## Usage

First, install `gulp-s3` as a development dependency:

```shell
npm install --save-dev gulp-s3
```


Then, use it in your `gulpfile.js`:
```javascript
var s3   = require('gulp-s3')
var gulp = require('gulp')

var AWS = {
  "key":    process.env.AWS_ACCESS_KEY_ID,
  "secret": process.env.AWS_SECRET_ACCESS_KEY,
  "bucket": "dev.example.com",
  "region": "eu-west-1"
}

gulp.task('default', () => {
  gulp.src('./dist/**').pipe(s3(AWS));
});
```

## API

#### options.uploadPath

Type: `String`          
Default: ``

Set the remote folder on the S3 bucket

```javascript
var options = { uploadPath: 'remote-folder' } // It will upload the 'src' into '/remote-folder'
gulp.src('./dist/**', {read: false})
    .pipe(s3(AWS, options));
```

#### options.headers

Type: `Object`          
Default: `{}`

Headers to set to each file uploaded to S3

```javascript
var options = { 
  headers: {
    'Cache-Control': 'max-age=315360000, no-transform, public',
    'x-amz-acl': 'private'
  } 
};
gulp.src('./dist/**', {read: false})
    .pipe(s3(AWS, options));
```

#### options.gzippedOnly

Type: `Boolean`          
Default: `false`

Only upload files with .gz extension, additionally it will remove the .gz suffix on destination filename and set appropriate Content-Type and Content-Encoding headers.

```javascript
var options = { gzippedOnly: true };
gulp.src('./dist/**').pipe(gzip())
    .pipe(s3(AWS, options));
```

#### options.failOnError
Type: `Boolean`
Default: `false`

Throw error if upload to s3 fails.

```javascript
var options = { failOnError: true };
gulp.src('./dist/**').pipe(gzip())
    .pipe(s3(AWS, options));
```

## License

[MIT License](http://en.wikipedia.org/wiki/MIT_License)

[npm-url]: https://npmjs.org/package/gulp-s3
[npm-image]: https://badge.fury.io/js/gulp-s3.png

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