52 lines
1.7 KiB
Markdown
52 lines
1.7 KiB
Markdown
# @uppy/companion-client
|
|
|
|
<img src="https://uppy.io/images/logos/uppy-dog-head-arrow.svg" width="120" alt="Uppy logo: a superman puppy in a pink suit" align="right">
|
|
|
|
[](https://www.npmjs.com/package/@uppy/companion-client)
|
|
|
|
|
|
|
|
|
|
Client library for communication with Companion. Intended for use in Uppy plugins.
|
|
|
|
Uppy is being developed by the folks at [Transloadit](https://transloadit.com), a versatile file encoding service.
|
|
|
|
## Example
|
|
|
|
```js
|
|
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.
|
|
|
|
```bash
|
|
$ npm install @uppy/companion-client
|
|
```
|
|
|
|
<!-- Undocumented currently
|
|
## Documentation
|
|
|
|
Documentation for this plugin can be found on the [Uppy website](https://uppy.io/docs/DOC_PAGE_HERE).
|
|
-->
|
|
|
|
## License
|
|
|
|
[The MIT License](./LICENSE).
|