uppy/packages/@uppy/server-utils
2018-07-14 09:17:05 +01:00
..
src refactor: use plugin id in error message 2018-07-14 09:17:05 +01:00
types refactor: allow Array, RegExp, and String for serverPattern 2018-07-01 12:43:40 +01:00
LICENSE Move UppySocket, RequestClient, Provider to @uppy/server-utils. 2018-06-14 16:31:19 +02:00
package.json Release 2018-06-28 17:12:13 +02:00
README.md Insert missing documentation links. 2018-06-18 13:20:19 +02:00

@uppy/server-utils

Uppy logo: a superman puppy in a pink suit

Build Status

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

License

The MIT License.