# @uppy/companion-client

> Client library for communication with Companion. Intended for use in Uppy plugins.

Latest version **5.1.1** (published 2025-10-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @uppy/companion-client
pnpm add @uppy/companion-client
yarn add @uppy/companion-client
bun add @uppy/companion-client
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: esm support; no vulnerabilities; high maintenance score; popular repo.

Warnings: low downloads; no types.

## Facts

| | |
|---|---|
| Version | 5.1.1 |
| Published | 2025-10-17 |
| First published | 2018-08-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM |
| Dependencies | 3 |
| Unpacked size | 98.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 31001 |
| Maintainers | kvz, tim-kos, murderlon, mifi, uppydev |
| Keywords | file uploader, uppy, uppy-plugin, companion, provider |

## Links

- npm: https://www.npmjs.com/package/@uppy/companion-client
- Repository: https://github.com/transloadit/uppy
- Homepage: https://uppy.io
- Issues: https://github.com/transloadit/uppy/issues
- npm.io page: https://npm.io/package/@uppy/companion-client

## Dependencies (3)

- [p-retry](https://npm.io/package/p-retry.md) ^6.1.0
- [@uppy/utils](https://npm.io/package/@uppy/utils.md) ^7.1.1
- [namespace-emitter](https://npm.io/package/namespace-emitter.md) ^2.0.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 5.1.1 (latest) — 2025-10-17
- 4.0.0-beta.9 (next) — 2024-07-02
- 5.1.0 — 2025-10-08
- 5.0.1 — 2025-09-16
- 5.0.0 — 2025-08-22
- 4.5.2 — 2025-08-01
- 4.5.1 — 2025-07-29
- 4.5.0 — 2025-07-29
- 4.4.2 — 2025-05-18
- 4.4.1 — 2025-01-09
- 4.4.0 — 2025-01-06
- 4.3.0 — 2024-12-17
- 4.2.0 — 2024-12-05
- 4.1.1 — 2024-10-31
- 4.1.0 — 2024-08-29
- … 86 more at https://npm.io/package/@uppy/companion-client/versions

## README

# @uppy/companion-client

<img src="https://uppy.io/img/logo.svg" width="120" alt="Uppy logo: a smiling puppy above a pink upwards arrow" align="right">

[![npm version](https://img.shields.io/npm/v/@uppy/companion-client.svg?style=flat-square)](https://www.npmjs.com/package/@uppy/companion-client)
![CI status for Uppy tests](https://github.com/transloadit/uppy/workflows/CI/badge.svg)
![CI status for Companion tests](https://github.com/transloadit/uppy/workflows/Companion/badge.svg)
![CI status for browser tests](https://github.com/transloadit/uppy/workflows/End-to-end%20tests/badge.svg)

Client library for communication with Companion. Intended for use in Uppy
plugins.

Uppy is being developed by the folks at [Transloadit](https://transloadit.com),
a versatile file encoding service.

## Example

```js
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.

```bash
$ npm install @uppy/companion-client
```

## Documentation

Documentation for this plugin can be found on the
[Uppy website](https://uppy.io/docs/companion).

## License

[The MIT License](./LICENSE).

---
_Source: https://npm.io/package/@uppy/companion-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._