Skip to main content
Capgo logo
Back to plugins
@capgo/capacitor-downloader
Tutorial
@capgo/capacitor-downloader

Downloader

Download large files in background with progress tracking and pause/resume support

Downloads/month

6.9k

GitHub Stars

10

Guide

Tutorial on Downloader

Using @capgo/capacitor-downloader

Capacitor plugin for downloading files with background support. Provides resumable downloads with progress tracking.

Install

bun add @capgo/capacitor-downloader
bunx cap sync

What This Plugin Exposes

  • download - Start a new download task.
  • pause - Pause an active download. Download can be resumed later from the same position.
  • resume - Resume a paused download. Continues from where it was paused.
  • stop - Stop and cancel a download permanently. Downloaded data will be deleted.

Example Usage

download

Start a new download task.

import { CapacitorDownloader } from '@capgo/capacitor-downloader';

const task = await Downloader.download({
  id: 'my-download',
  url: 'https://example.com/file.pdf',
  destination: 'downloads/file.pdf'
});

pause

Pause an active download. Download can be resumed later from the same position.

import { CapacitorDownloader } from '@capgo/capacitor-downloader';

await CapacitorDownloader.pause({} as { id: string });

resume

Resume a paused download. Continues from where it was paused.

import { CapacitorDownloader } from '@capgo/capacitor-downloader';

await CapacitorDownloader.resume({} as { id: string });

stop

Stop and cancel a download permanently. Downloaded data will be deleted.

import { CapacitorDownloader } from '@capgo/capacitor-downloader';

await CapacitorDownloader.stop({} as { id: string });

Full Reference

Keep going from Using @capgo/capacitor-downloader

If you are using Using @capgo/capacitor-downloader to plan migration and enterprise operations, connect it with @capgo/capacitor-downloader for the implementation detail in @capgo/capacitor-downloader, 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.