National Preventative Mechanism

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

    2.0.3 • Public • Published

    @uppy/companion-client

    Uppy logo: a superman puppy in a pink suit

    npm version 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

    import Uppy from '@uppy/core'
    import { Provider, RequestClient, Socket } from '@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

    Homepage

    uppy.io

    DownloadsWeekly Downloads

    85,290

    Version

    2.0.3

    License

    MIT

    Unpacked Size

    70 kB

    Total Files

    28

    Last publish

    Collaborators

    • mifi
    • aduh95
    • kvz
    • tim-kos
    • ifedapoolarewaju
    • murderlon
    • goto-bus-stop
    • arturi