Empezar

Copie una línea de comando de configuración con los pasos de instalación y la guía markdown completa para este plugin.

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/capacitor-downloader`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/downloader/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

Sección titulada “Instalar”

bun add @capgo/capacitor-downloader
bunx cap sync

Importar

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

API Resumen

`download`

Iniciar una nueva tarea de descarga.

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`

Pausar una descarga activa. La descarga puede ser reanudada más tarde desde la misma posición.

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

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

`resume`

Reanuda una descarga pausada. Continúa desde donde se pausó.

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

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

`stop`

Detener y cancelar una descarga de manera permanente. Los datos descargados serán eliminados.

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

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

`checkStatus`

Comprueba el estado actual de una descarga.

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

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

`getFileInfo`

Obtén información sobre un archivo descargado.

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

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

Referencia de tipos

`DownloadOptions`

Opciones de configuración para iniciar una descarga.

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`

Representa el estado actual y el progreso de una tarea de descarga.

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

Fuente de Verdad

Esta página se genera a partir del plugin’s. src/definitions.tsRe-ejecutar la sincronización cuando los cambios públicos API cambien en la fuente.