Skip to main content
Back to plugins
@capgo/capacitor-uploader
Tutorial
@capgo/capacitor-uploader

Uploader

Upload large files reliably in background with progress tracking and retry support

Guide

Tutorial on Uploader

Using @capgo/capacitor-uploader

Capacitor Uploader Plugin for uploading files with background support and progress tracking.

Install

bun add @capgo/capacitor-uploader
bunx cap sync

What This Plugin Exposes

  • startUpload - Start uploading a file to a server.
  • removeUpload - Cancel and remove an ongoing upload.

Example Usage

startUpload

Start uploading a file to a server.

import { Uploader } from '@capgo/capacitor-uploader';

const { id } = await Uploader.startUpload({
  filePath: 'file:///path/to/file.jpg',
  serverUrl: 'https://example.com/upload',
  headers: {
    'Authorization': 'Bearer token'
  },
  method: 'POST',
  uploadType: 'multipart',
  fileField: 'photo'
});
console.log('Upload started with ID:', id);

removeUpload

Cancel and remove an ongoing upload.

import { Uploader } from '@capgo/capacitor-uploader';

await Uploader.removeUpload({ id: 'upload-123' });

Full Reference

Keep going from Using @capgo/capacitor-uploader

If you are using Using @capgo/capacitor-uploader to plan migration and enterprise operations, connect it with @capgo/capacitor-uploader for the implementation detail in @capgo/capacitor-uploader, Getting Started for the implementation detail in Getting Started, Capgo Enterprise for the product workflow in Capgo Enterprise, Ionic Enterprise Plugin Alternatives for the product workflow in Ionic Enterprise Plugin Alternatives, and Capgo Alternatives for the product workflow in Capgo Alternatives.