mirror of https://github.com/transloadit/uppy.git synced 2026-07-23 18:29:09 +00:00

Move UppySocket, RequestClient, Provider to @uppy/server-utils.

Steps taken:

```bash
cp -R package-template packages/@uppy/server-utils
git mv src/server/* packages/@uppy/server-utils/src
git mv src/core/UppySocket.js packages/@uppy/server-utils/src/Socket.js
git mv src/core/UppySocket.test.js packages/@uppy/server-utils/src/Socket.test.js
vim packages/@uppy/server-utils/src/index.js # add Socket export
vim packages/@uppy/server-utils/{package.json,README.md}
grep 'require.*server' -l -r src # Find `src/server/*` requires
grep UppySocket -r src # Find `src/core/UppySocket` requires
vim ... # update all those
```

2018-06-14 16:31:19 +02:00

1.5 KiB

Raw Blame History

@uppy/server-utils

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

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

Example

const Uppy = require('@uppy/core')
const { Provider, RequestClient, Socket } = require('@uppy/server-utils')

const uppy = Uppy()

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

const provider = new Provider(uppy, {
  serverUrl: '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/server-utils --save

Documentation

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

License

The MIT License.

1.5 KiB Raw Blame History