Merlijn Vos f01538ba41 Resolve all type `TODO`'s (#2963) 3 years ago
..
src f01538ba41 Resolve all type `TODO`'s (#2963) 3 years ago
types 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
LICENSE a0798cf5ee Move S3 Multipart upload to a separate package. 6 years ago
README.md c48064ba56 doc: lint JS code snippets (#2954) 3 years ago
package.json 4b782ffbbb Release 3 years ago

README.md

@uppy/aws-s3-multipart

CI status for Uppy tests CI status for Companion tests CI status for browser tests

The AwsS3Multipart plugin can be used to upload files directly to an S3 bucket using S3’s Multipart upload strategy. With this strategy, files are chopped up in parts of 5MB+ each, so they can be uploaded concurrently. It’s also very reliable: if a single part fails to upload, only that 5MB has to be retried.

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

Example

import Uppy from '@uppy/core'
import AwsS3Multipart from '@uppy/aws-s3-multipart'

const uppy = new Uppy()
uppy.use(AwsS3Multipart, {
  limit: 2,
  companionUrl: 'https://companion.myapp.com/',
})

Installation

$ npm install @uppy/aws-s3-multipart

We recommend installing from npm and then using a module bundler such as Webpack, Browserify or Rollup.js.

Alternatively, you can also use this plugin in a pre-built bundle from Transloadit's 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.