@capgo/capacitor-uploader

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

Overview

@capgo/capacitor-uploader moves large files off the device with native background uploads on iOS and Android. Progress and completion arrive through plugin events, so your UI can detach while uploads continue. Pair it with camera capture or filesystem paths instead of buffering whole files in the WebView.

Common uses: photo or video backup, presigned S3 uploads, multipart form posts with metadata fields, and resilient retries via maxRetries.

Platform support

Platform	Background upload	Notes
iOS	Yes	Background `URLSession`
Android	Yes	Foreground service style notification while uploading
Web	While page open	`fetch` based, no native background continuation

Web also supports IndexedDB style paths: idb://[database]/[collection]/[key].

Core Capabilities

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

Public API

Method	Description
`startUpload`	Start uploading a file to a server.
`removeUpload`	Cancel and remove an ongoing upload.
`addListener`	Listen for upload progress and status events.
`getPluginVersion`	Get the native Capacitor plugin version.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-uploader.

Keep going from @capgo/capacitor-uploader

If you are using @capgo/capacitor-uploader to plan storage and file handling, connect it with Using @capgo/capacitor-uploader for the native capability in Using @capgo/capacitor-uploader, @capgo/capacitor-data-storage-sqlite for the implementation detail in @capgo/capacitor-data-storage-sqlite, Using @capgo/capacitor-data-storage-sqlite for the native capability in Using @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-file for the implementation detail in @capgo/capacitor-file, and Using @capgo/capacitor-file for the native capability in Using @capgo/capacitor-file.