# egg-s3

> aws s3 client for egg

Latest version **1.0.2** (published 2017-12-04) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2017-12-04 |
| First published | 2017-12-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | royguo |
| Maintainers | royguo |
| Keywords | egg, eggPlugin, egg-plugin |

## Links

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

## Dependencies (1)

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

## Recent versions

- 1.0.2 (latest) — 2017-12-04
- 1.0.1 — 2017-12-01
- 1.0.0 — 2017-12-01

## README

# egg-s3

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-s3.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-s3
[travis-image]: https://img.shields.io/travis/eggjs/egg-s3.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-s3
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-s3.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-s3?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-s3.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-s3
[snyk-image]: https://snyk.io/test/npm/egg-s3/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-s3
[download-image]: https://img.shields.io/npm/dm/egg-s3.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-s3

<!--
Description here.
-->

## Install

```bash
$ npm i egg-s3 --save
```

## Usage

```js
// {app_root}/config/plugin.js
exports.s3 = {
  enable: true,
  package: 'egg-s3',
};
```

## Configuration

```js
// {app_root}/config/config.default.js
exports.s3 = {
  app: true,
  agent: false,
  maxAsyncS3: 20,     // this is the default
  s3RetryCount: 3,    // this is the default
  s3RetryDelay: 1000, // this is the default
  multipartUploadThreshold: 20971520, // this is the default (20 MB)
  multipartUploadSize: 15728640, // this is the default (15 MB),
  s3Options: {
  accessKeyId: 'xxxx',
  secretAccessKey: 'xxxx',
  region: 'test',
  endpoint: 'http://www.google.com',
  sslEnabled: false,
  s3ForcePathStyle: true,
},
};
```

see [config/config.default.js](config/config.default.js) for more detail.

## Example

<!-- example here -->

## Questions & Suggestions

Please open an issue [here](https://github.com/eggjs/egg/issues).

## License

[MIT](LICENSE)

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