uppy/packages/@uppy/aws-s3
Merlijn Vos 7d6937300a
meta: enable prettier for markdown (#5133)
* meta: enable prettier for markdown

* Ignore changelogs

* revert CHANGELOG changes

* More formatting

---------

Co-authored-by: Antoine du Hamel <duhamelantoine1995@gmail.com>
2024-05-02 11:35:55 +02:00
..
src update UppyFile objects before emitting events (#4928) 2024-02-19 16:25:01 +01:00
types meta: add support for TypeScript plugins (#4640) 2023-10-17 15:38:15 +02:00
CHANGELOG.md Release: uppy@3.22.0 (#4929) 2024-02-19 16:29:43 +00:00
LICENSE Move AwsS3 to @uppy/aws-s3 2018-06-17 21:52:17 -04:00
package.json Release: uppy@3.22.1 (#4935) 2024-02-20 09:36:32 +00:00
README.md meta: enable prettier for markdown (#5133) 2024-05-02 11:35:55 +02:00

@uppy/aws-s3

Uppy logo: a smiling puppy above a pink upwards arrow

npm version CI status for Uppy tests CI status for Companion tests CI status for browser tests

The AwsS3 plugin can be used to upload files directly to an S3 bucket. Uploads can be signed using Companion or a custom signing function.

Uppy is being developed by the folks at Transloadit, a versatile file encoding service.

Example

import Uppy from '@uppy/core'
import AwsS3 from '@uppy/aws-s3'

const uppy = new Uppy()
uppy.use(AwsS3, {
  limit: 2,
  timeout: ms('1 minute'),
  companionUrl: 'https://companion.myapp.com/',
})

Installation

$ npm install @uppy/aws-s3

Alternatively, you can also use this plugin in a pre-built bundle from Transloadits CDN: Edgly. In that case Uppy will attach itself to the global window.Uppy object. See the main Uppy documentation for instructions.

Documentation

Documentation for this plugin can be found on the Uppy website.

License

The MIT License.