@uppy/companion-client

Client library for communication with Companion. Intended for use in Uppy plugins.

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

Example

import Uppy from '@uppy/core'
import { Provider, RequestClient, Socket } from '@uppy/companion-client'

const uppy = new Uppy()

const client = new RequestClient(uppy, {
  companionUrl: 'https://uppy.mywebsite.com/',
})
client.get('/drive/list').then(() => {})

const provider = new Provider(uppy, {
  companionUrl: 'https://uppy.mywebsite.com/',
  provider: providerPluginInstance,
})
provider.checkAuth().then(() => {})

const socket = new Socket({ target: 'wss://uppy.mywebsite.com/' })
socket.on('progress', () => {})

Installation

Unless you are writing a custom provider plugin, you do not need to install this.

$ npm install @uppy/companion-client

Documentation

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

License

The MIT License.

Current Tags

3.8.2 ... latest (2 years ago)
4.0.0-beta.9 ... next (2 years ago)

85 Versions

4.0.0-beta.9 ... 2 years ago
3.8.2 ... 2 years ago
4.0.0-beta.8 ... 2 years ago
4.0.0-beta.7 ... 2 years ago
4.0.0-beta.6 ... 2 years ago
4.0.0-beta.5 ... 2 years ago
4.0.0-beta.4 ... 2 years ago
3.8.1 ... 2 years ago
4.0.0-beta.3 ... 2 years ago
4.0.0-beta.2 ... 2 years ago
4.0.0-beta.1 ... 2 years ago
3.8.0 ... 2 years ago
3.7.4 ... 2 years ago
3.7.3 ... 2 years ago
3.7.2 ... 2 years ago
3.7.1 ... 2 years ago
3.7.0 ... 2 years ago
3.6.1 ... 2 years ago
3.6.0 ... 2 years ago
3.5.0 ... 2 years ago
3.4.1 ... 3 years ago
3.4.0 ... 3 years ago
3.3.0 ... 3 years ago
3.2.2 ... 3 years ago
3.2.1 ... 3 years ago
3.2.0 ... 3 years ago
3.1.3 ... 3 years ago
3.1.2 ... 3 years ago
3.1.1 ... 3 years ago
3.1.0 ... 3 years ago
3.0.2 ... 4 years ago
3.0.1 ... 4 years ago
3.0.0 ... 4 years ago
2.2.2 ... 4 years ago
3.0.0-beta.2 ... 4 years ago
3.0.0-beta.1 ... 4 years ago
2.2.1 ... 4 years ago
3.0.0-beta ... 4 years ago
2.2.0 ... 4 years ago
2.1.0 ... 4 years ago
2.0.6 ... 4 years ago
2.0.5 ... 4 years ago
2.0.4 ... 4 years ago
2.0.3 ... 5 years ago
2.0.2 ... 5 years ago
2.0.1 ... 5 years ago
2.0.0 ... 5 years ago
2.0.0-alpha.0 ... 5 years ago
1.10.2 ... 5 years ago
1.10.1 ... 5 years ago
1.10.0 ... 5 years ago
1.9.0 ... 5 years ago
1.8.3 ... 5 years ago
1.8.2 ... 5 years ago
1.8.1 ... 5 years ago
1.8.0 ... 5 years ago
1.7.0 ... 5 years ago
1.6.1 ... 5 years ago
1.6.0 ... 5 years ago
1.5.4 ... 6 years ago
1.5.3 ... 6 years ago
1.5.2 ... 6 years ago
1.5.1 ... 6 years ago
1.5.0 ... 6 years ago
1.4.5 ... 6 years ago
1.4.4 ... 6 years ago
1.4.3 ... 6 years ago
1.4.2 ... 6 years ago
1.4.1 ... 7 years ago
1.4.0 ... 7 years ago
1.3.0 ... 7 years ago
1.2.0 ... 7 years ago
1.1.0 ... 7 years ago
1.0.1 ... 7 years ago
1.0.0 ... 7 years ago
0.28.5 ... 7 years ago
0.28.4 ... 7 years ago
0.28.3 ... 7 years ago
0.28.2 ... 7 years ago
0.28.1 ... 7 years ago
0.28.0 ... 7 years ago
0.27.3 ... 7 years ago
0.27.2 ... 8 years ago
0.27.1 ... 8 years ago
0.27.0 ... 8 years ago