django-vue3-admin-web/node_modules/@uppy/companion-client
2025-10-20 21:21:14 +08:00
..
lib 初始化 2025-10-20 21:21:14 +08:00
src 初始化 2025-10-20 21:21:14 +08:00
types 初始化 2025-10-20 21:21:14 +08:00
CHANGELOG.md 初始化 2025-10-20 21:21:14 +08:00
LICENSE 初始化 2025-10-20 21:21:14 +08:00
package.json 初始化 2025-10-20 21:21:14 +08:00
README.md 初始化 2025-10-20 21:21:14 +08:00

@uppy/companion-client

Uppy logo: a superman puppy in a pink suit

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

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

License

The MIT License.