Renée Kooi e83509b689 Remove whatwg-fetch polyfill. 6 years ago
..
src e83509b689 Remove whatwg-fetch polyfill. 6 years ago
types 1222873698 Remove unnecessary `declare module` wrappers from .d.ts files. 6 years ago
LICENSE 50be5119fa Move `UppySocket`, `RequestClient`, `Provider` to `@uppy/server-utils`. 6 years ago
README.md 8d2b6a8a05 Insert missing documentation links. 6 years ago
package.json e83509b689 Remove whatwg-fetch polyfill. 6 years ago

README.md

@uppy/server-utils

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.