@uppy/server-utils
TypeScript icon, indicating that this package has built-in type declarations

0.26.0 • Public • Published

@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.

Package Sidebar

Install

npm i @uppy/server-utils

Homepage

uppy.io

Weekly Downloads

111

Version

0.26.0

License

MIT

Unpacked Size

26.3 kB

Total Files

18

Last publish

Collaborators

  • mifi
  • aduh95
  • kvz
  • tim-kos
  • murderlon