Guía
Cómo usar File en Capacitor
Uso de @capgo/capacitor-file
El plugin de Capacitor File implementa operaciones del sistema de archivos similares al plugin Cordova File.
Instalar
bun add @capgo/capacitor-file
bunx cap sync
bunx cap sync copia el code nativo del plugin en tus proyectos nativos. Ejecútalo de nuevo tras cada actualización del plugin.
Importar
import { CapacitorFile } from '@capgo/capacitor-file';
API de un vistazo
| Método | Descripción |
|---|---|
requestFileSystem |
Solicitar un sistema de archivos. |
resolveLocalFileSystemURL |
Resolver una URL de archivo a una entrada. |
getFile |
Obtener una entrada de archivo. |
getDirectory |
Obtener una entrada de directorio. |
readFile |
Leer un archivo como texto o base64. |
readAsDataURL |
Leer un archivo como data URL (base64 con prefijo MIME). |
writeFile |
Escribir datos en un archivo. |
appendFile |
Añadir datos a un archivo. |
deleteFile |
Elimina un archivo. |
mkdir |
Crear un directorio. |
rmdir |
Eliminar un directorio. |
readdir |
Leer el contenido de un directorio. |
stat |
Obtener metadatos de un archivo o directorio. |
getMetadata |
Obtener metadatos de un archivo o directorio. Alias de stat(). |
rename |
Renombrar o mover un archivo o directorio. |
move |
Mover un archivo o directorio. Alias de rename(). |
copy |
Copiar un archivo o directorio. |
exists |
Comprobar si un archivo o directorio existe. |
getUri |
Obtener la URI de un archivo. |
truncate |
Trunca un archivo a un tamaño específico. |
getDirectories |
Get all known file system directories. |
getFreeDiskSpace |
Obtén el espacio libre en disco en bytes. |
checkPermissions |
Comprueba el estado de permisos para operaciones de archivos. En Android, verifica los permisos de almacenamiento externo. En iOS y web, siempre devuelve 'granted' ya que no se requieren permisos especiales. |
requestPermissions |
Solicita permisos para operaciones de archivos. En Android, pide los permisos de almacenamiento externo necesarios para acceder a archivos fuera de los directorios privados de la app. En iOS y web, siempre devuelve 'granted' ya que no se requieren permisos especiales. |
Ejemplos
requestFileSystem()
Solicita un sistema de archivos.
import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';
const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);
resolveLocalFileSystemURL()
Resuelve una URL de archivo a una entrada.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);
getFile()
Obtén una entrada de archivo.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);
getDirectory()
Obtén una entrada de directorio.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);
readFile()
Lee un archivo como texto o base64.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);
readAsDataURL()
Lee un archivo como una data URL (base64 con prefijo MIME).
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);
La tabla anterior enumera los 24 métodos principales. Los helpers de listener y versión, así como el contrato completo de cada método, están documentados en la repositorio GitHub.
Escuchar eventos
addListener devuelve un handle. Llama handle.remove() cuando la pantalla se desmonta, o CapacitorFile.removeAllListeners() para limpiar todos los listeners.
Referencia completa
Continúa desde Using @capgo/capacitor-file
Si estás usando Uso de @capgo/capacitor-file para planificar el almacenamiento y la gestión de archivos, conéctalo con @capgo/capacitor-file para el detalle de implementación en @capgo/capacitor-file, Primeros pasos para los detalles de implementación en Primeros pasos, @capgo/capacitor-data-storage-sqlite para el detalle de implementación en @capgo/capacitor-data-storage-sqlite, Uso de @capgo/capacitor-data-storage-sqlite para la capacidad nativa en Uso de @capgo/capacitor-data-storage-sqlite, y @capgo/capacitor-uploader para el detalle de implementación en @capgo/capacitor-uploader.