# the-s3

> S3 upload helper

Latest version **1.0.8** (published 2018-12-14) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.8 |
| Published | 2018-12-14 |
| First published | 2018-07-28 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 4 |
| Unpacked size | 44.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | okunishinishi |
| Maintainers | okunishinishi |
| Keywords | the |

## Links

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

## Dependencies (4)

- [mime](https://npm.io/package/mime.md) ^2.4.0
- [debug](https://npm.io/package/debug.md) ^4.1.0
- [aws-sdk](https://npm.io/package/aws-sdk.md) ^2.376.0
- [the-check](https://npm.io/package/the-check.md) ^2.0.17

## Alternatives

- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads
- [escher-request](https://npm.io/package/escher-request.md) — 545 weekly downloads

## Recent versions

- 1.0.8 (latest) — 2018-12-14
- 1.0.7 — 2018-12-05
- 1.0.5 — 2018-12-05
- 1.0.4 — 2018-11-24
- 1.0.3 — 2018-10-29
- 1.0.2 — 2018-08-13
- 1.0.1 — 2018-07-28
- 1.0.0 — 2018-07-28

## README

the-s3
==========

<!---
This file is generated by the-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/the-labo/the-s3
[bd_travis_url]: http://travis-ci.org/the-labo/the-s3
[bd_travis_shield_url]: http://img.shields.io/travis/the-labo/the-s3.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/the-labo/the-s3
[bd_travis_com_shield_url]: https://api.travis-ci.com/the-labo/the-s3.svg?token=
[bd_license_url]: https://github.com/the-labo/the-s3/blob/master/LICENSE
[bd_npm_url]: http://www.npmjs.org/package/the-s3
[bd_npm_shield_url]: http://img.shields.io/npm/v/the-s3.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

S3 upload helper

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install the-s3 --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const {TheS3} = require('the-s3')

async function tryExample () {
  const s3 = new TheS3({
    accessKeyId: 'xxxxx',
    bucket: 'myBucket01',
    region: 'ap-northeast-1',
    secretAccessKey: 'xxxxxxxxx',
    signatureVersion: 'v4',
  })

  await s3('some-text.txt', {})
}

tryExample().catch((err) => console.error(err))

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/10.API Guide.md.hbs" Start -->

<a name="section-doc-guides-10-a-p-i-guide-md"></a>

API Guide
-----

+ [the-s3@1.0.8](./doc/api/api.md)
  + [create(args)](./doc/api/api.md#the-s3-function-create)
  + [TheS3](./doc/api/api.md#the-s3-class)


<!-- Section from "doc/guides/10.API Guide.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/the-labo/the-s3/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [THE Labo][t_h_e_labo_url]

[t_h_e_labo_url]: https://github.com/the-labo

<!-- Links End -->

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