npm.io
6.0.0 • Published 3 weeks ago

@uppy/transloadit

Licence
MIT
Version
6.0.0
Deps
3
Size
162 kB
Vulns
0
Weekly
0
Stars
31.0K

@uppy/transloadit

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 Transloadit plugin can be used to upload files to Transloadit for all kinds of processing, such as transcoding video, resizing images, zipping/unzipping, and more.

Uppy owns the open-source browser upload experience. Transloadit is the managed backend that receives those uploads and runs the processing workflow. This plugin connects the two; Uppy can also be used with other upload destinations.

Run the unsigned local demo → (test use only). For production, follow the server-signed integration guide.

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

Example

import Uppy from '@uppy/core'
import Transloadit from '@uppy/transloadit'

const uppy = new Uppy().use(Transloadit, {
  async assemblyOptions() {
    const response = await fetch('/api/transloadit-params', { method: 'POST' })
    if (!response.ok) {
      throw new Error(`Could not prepare the upload (${response.status})`)
    }
    return response.json()
  },
})

Generate the returned params and signature on your server. Never include your Transloadit Auth Secret in browser code. See the canonical JavaScript, React, Next.js, Vue, and Angular guide for complete examples.

Installation

$ npm install @uppy/transloadit

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

Keywords