Have ideas to improve npm?Join in the discussion! ¬Ľ

    @ssh-uppy/companion-client
    TypeScript icon, indicating that this package has built-in type declarations

    1.5.2¬†‚Äʬ†Public¬†‚Äʬ†Published

    @uppy/companion-client

    Uppy logo: a superman puppy in a pink suit

    Build Status

    Client library for communication with Companion. 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/companion-client')
     
    const uppy = 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.

    $ npm install @uppy/companion-client --save

    License

    The MIT License.

    Install

    npm i @ssh-uppy/companion-client

    DownloadsWeekly Downloads

    2

    Version

    1.5.2

    License

    MIT

    Unpacked Size

    66.2 kB

    Total Files

    25

    Homepage

    uppy.io

    Last publish

    Collaborators

    • avatar