github-actions[bot] 2af711cf28 Release: uppy@2.3.0 (#3348) 3 years ago
..
src bfe659820e Upgrade linting to 2.0.0-0 (#3280) 3 years ago
types 5630f7dc07 tools: enable linter for TypeScript (#2997) 3 years ago
LICENSE 67e57c9899 Move `Tus` plugin to `@uppy/tus`. 6 years ago
README.md 55e0ffd04a Add retext to markdown linter (#3024) 3 years ago
package.json 2af711cf28 Release: uppy@2.3.0 (#3348) 3 years ago

README.md

@uppy/tus

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

The Tus plugin brings tus.io resumable file uploading to Uppy by wrapping the tus-js-client.

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

Example

import Uppy from '@uppy/core'
import Tus from '@uppy/tus'

const uppy = new Uppy()
uppy.use(Tus, {
  endpoint: 'https://tusd.tusdemo.net/files/', // use your tus endpoint here
  resume: true,
  retryDelays: [0, 1000, 3000, 5000],
})

Installation

$ npm install @uppy/tus

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.