Mulai

Bagian berjudul “Pasang”

bun add @capgo/capacitor-downloader
bunx cap sync

Impor

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

API Ringkasan

download

Mulai tugas download baru.

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

Tangguhkan download aktif. Download dapat dilanjutkan kemudian dari posisi yang sama.

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

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

resume

Mengaktifkan kembali download yang terhenti. Melanjutkan dari tempat yang dihentikan.

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

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

stop

Menghentikan dan membatalkan download secara permanen. Data yang telah diunduh akan dihapus.

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

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

checkStatus

Periksa status saat ini dari download.

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

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

getFileInfo

Dapatkan informasi tentang file yang telah diunduh.

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

await CapacitorDownloader.getFileInfo({} as { path: string });

Referensi Tipe

DownloadOptions

Opsi pengaturan untuk memulai download.

export interface DownloadOptions {
  /** Unique identifier for this download task */
  id: string;
  /** URL of the file to download */
  url: string;
  /** Local file path where the download will be saved */
  destination: string;
  /** Optional HTTP headers to include in the request */
  headers?: { [key: string]: string };
  /** Network type requirement for download */
  network?: 'cellular' | 'wifi-only';
  /** Download priority level */
  priority?: 'high' | 'normal' | 'low';
}

DownloadTask

Menggambarkan keadaan dan kemajuan saat ini dari tugas download.

export interface DownloadTask {
  /** Unique identifier for the download task */
  id: string;
  /** Download progress from 0 to 100 */
  progress: number;
  /** Current state of the download */
  state: 'PENDING' | 'RUNNING' | 'PAUSED' | 'DONE' | 'ERROR';
}

Sumber Kebenaran

Halaman ini dihasilkan dari plugin’s. src/definitions.tsRe-run sinkronisasi ketika publik API berubah di atas.