시작하기

설치

bun add @capgo/capacitor-downloader
bunx cap sync

수입

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

API 개요

download

새 다운로드 작업을 시작하세요.

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

다운로드 중단: 다운로드를 중단하고 나중에 같은 위치에서 다시 시작할 수 있습니다.

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

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

resume

일시 중단된 다운로드를 재개합니다. 다시 시작할 때는 이전에 중단된 위치에서 시작합니다.

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

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

stop

다운로드를 중단하고 영구적으로 취소합니다. 다운로드한 데이터는 삭제됩니다.

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

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

checkStatus

클립보드에 복사

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

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

getFileInfo

다운로드한 파일에 대한 정보를 확인하세요.

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

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

타입 참조

DownloadOptions

다운로드를 시작하는 데 필요한 구성 옵션입니다.

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

다운로드 태스크의 현재 상태와 진행 상황을 나타냅니다.

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';
}

실질적 진원지

이 페이지는 플러그인의 src/definitions.tsAPI이 업스트림에서 변경될 때마다 pubic을 다시 동기화하세요.