Not Particularly Meaningful
    Wondering what’s next for npm?Check out our public roadmap! »

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

    1.9.0 • Public • Published

    @uppy/companion-client

    Uppy logo: a superman puppy in a pink suit

    CI status for Uppy tests CI status for Companion tests CI status for browser tests

    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 = new 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

    License

    The MIT License.

    Install

    npm i @uppy/companion-client

    DownloadsWeekly Downloads

    77,752

    Version

    1.9.0

    License

    MIT

    Unpacked Size

    76.2 kB

    Total Files

    28

    Homepage

    uppy.io

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar