@uppy/companion-client
Advanced tools
Client library for communication with Companion. Intended for use in Uppy plugins.
@uppy/companion-client is a client-side library for Uppy, a modular file uploader for web browsers. It allows you to interact with Uppy Companion, a server-side component that handles file uploads from various sources such as local disk, remote URLs, and cloud services like Google Drive, Dropbox, and Instagram.
Upload Files
This feature allows you to upload files to a specified endpoint using the Companion server. The code sample demonstrates how to upload a file named 'example.txt' to a Companion server.
const { uploadFile } = require('@uppy/companion-client');
const file = new File(['content'], 'example.txt', { type: 'text/plain' });
uploadFile(file, {
endpoint: 'https://your-companion-server.com/upload',
fieldName: 'file'
}).then(response => {
console.log('File uploaded successfully:', response);
}).catch(error => {
console.error('Error uploading file:', error);
});Generate Pre-signed URLs
This feature allows you to generate pre-signed URLs for uploading files directly to cloud storage services like Amazon S3. The code sample demonstrates how to generate a pre-signed URL for a file named 'example.txt'.
const { getPreSignedUrl } = require('@uppy/companion-client');
getPreSignedUrl('https://your-companion-server.com/s3', {
filename: 'example.txt',
contentType: 'text/plain'
}).then(response => {
console.log('Pre-signed URL:', response.url);
}).catch(error => {
console.error('Error generating pre-signed URL:', error);
});List Files
This feature allows you to list files from a specified source, such as Google Drive or Dropbox, using the Companion server. The code sample demonstrates how to list files from Google Drive.
const { list } = require('@uppy/companion-client');
list('https://your-companion-server.com/drive').then(response => {
console.log('Files:', response.items);
}).catch(error => {
console.error('Error listing files:', error);
});tus-js-client is a client-side library for the tus resumable upload protocol. It allows you to upload large files in chunks, resume interrupted uploads, and handle network issues. Unlike @uppy/companion-client, which is designed to work with Uppy and its Companion server, tus-js-client focuses on resumable uploads and can be used independently.
Fine Uploader is a JavaScript library for file uploads that supports multiple file selection, drag-and-drop, and resumable uploads. It provides a comprehensive set of features for file uploading, including support for various cloud storage services. Compared to @uppy/companion-client, Fine Uploader offers a more extensive set of features but may require more configuration.
Dropzone is a JavaScript library that provides drag-and-drop file uploads with image previews. It is easy to set up and use, making it a popular choice for simple file upload needs. While Dropzone offers basic file upload functionality, it lacks the advanced features and integrations provided by @uppy/companion-client.
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.
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', () => {})
Unless you are writing a custom provider plugin, you do not need to install this.
$ npm install @uppy/companion-client
3.1.0
Released: 2022-09-25
| Package | Version | Package | Version | | ------------------------- | ------- | ------------------------- | ------- | | @uppy/angular | 0.4.2 | @uppy/onedrive | 3.0.1 | | @uppy/audio | 1.0.2 | @uppy/progress-bar | 3.0.1 | | @uppy/aws-s3 | 3.0.2 | @uppy/provider-views | 3.0.1 | | @uppy/aws-s3-multipart | 3.0.2 | @uppy/react | 3.0.2 | | @uppy/box | 2.0.1 | @uppy/redux-dev-tools | 3.0.1 | | @uppy/companion | 4.0.2 | @uppy/remote-sources | 1.0.2 | | @uppy/companion-client | 3.0.2 | @uppy/screen-capture | 3.0.1 | | @uppy/compressor | 1.0.1 | @uppy/status-bar | 3.0.1 | | @uppy/core | 3.0.2 | @uppy/store-default | 3.0.2 | | @uppy/dashboard | 3.1.0 | @uppy/store-redux | 3.0.2 | | @uppy/drag-drop | 3.0.1 | @uppy/svelte | 3.0.1 | | @uppy/drop-target | 2.0.1 | @uppy/thumbnail-generator | 3.0.2 | | @uppy/dropbox | 3.0.1 | @uppy/transloadit | 3.0.2 | | @uppy/facebook | 3.0.1 | @uppy/tus | 3.0.2 | | @uppy/file-input | 3.0.1 | @uppy/unsplash | 3.0.1 | | @uppy/form | 3.0.1 | @uppy/url | 3.0.1 | | @uppy/golden-retriever | 3.0.1 | @uppy/utils | 5.0.2 | | @uppy/google-drive | 3.0.1 | @uppy/vue | 1.0.1 | | @uppy/image-editor | 2.0.1 | @uppy/webcam | 3.2.0 | | @uppy/informer | 3.0.1 | @uppy/xhr-upload | 3.0.2 | | @uppy/instagram | 3.0.1 | @uppy/zoom | 2.0.1 | | @uppy/locales | 3.0.1 | uppy | 3.1.0 |
disc.html page (Antoine du Hamel / #4119)Restrictor counts ghost files against maxNumberOfFiles (Andrew McIntee / #4078)Core export to warn users about the renaming (Antoine du Hamel / #4085)Uppy.Core (Antoine du Hamel / #4082)e2e.yml (Antoine du Hamel)Known issues section on Migration Guide (Antoine du Hamel / #4066)metaFields option (Antoine du Hamel / #4073)FAQs
Client library for communication with Companion. Intended for use in Uppy plugins.
The npm package @uppy/companion-client receives a total of 91,496 weekly downloads. As such, @uppy/companion-client popularity was classified as popular.
We found that @uppy/companion-client demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Node.js will be enforcing stricter semver-major PR policies a month before major releases to enhance stability and ensure reliable release candidates.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.