Guía
Cómo usar Archivos en Capacitor
Probar en dispositivo
Descargar la aplicación Capgo, luego escanea el código QR code.
Usando @capgo/capacitor-file
Capacitor Plugin de archivo Implementa operaciones de sistema de archivos similares al plugin de archivo de Cordova.
Instalar
bun add @capgo/capacitor-file
bunx cap sync
bunx cap sync copia el plugin de code nativo en tus proyectos nativos. Correlo de nuevo después de cada actualización del plugin.
Importar
import { CapacitorFile } from '@capgo/capacitor-file';
Vista general de API
| Tipo de 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 una URL de datos (base64 con prefijo MIME). |
writeFile |
Escribir datos en un archivo. |
appendFile |
Agregar datos a un archivo. |
deleteFile |
Borrar un archivo. |
mkdir |
Crear un directorio. |
rmdir |
Borrar un directorio. |
readdir |
Lee el contenido del directorio. |
stat |
Obtenga metadatos sobre un archivo o directorio. |
getMetadata |
Obtenga metadatos sobre un archivo o directorio. Símbolo para stat(). |
rename |
Renombre o mueva un archivo o directorio. |
move |
Mueva un archivo o directorio. Símbolo para rename(). |
copy |
Copie un archivo o directorio. |
exists |
Verifique si un archivo o directorio existe. |
getUri |
Obtenga la URI para un archivo. |
truncate |
Truncue un archivo a un tamaño especificado. |
getDirectories |
Get all known file system directories. |
getFreeDiskSpace |
Obtenga el espacio libre en disco en bytes. |
checkPermissions |
Verifique el estado de permiso actual para operaciones de archivo. En Android, esto verifica las permisos de almacenamiento externo. En iOS y web, siempre devuelve 'concedido' ya que no se necesitan permisos especiales. |
requestPermissions |
Solicite permisos para operaciones de archivo. En Android, esto solicita permisos de almacenamiento externo necesarios para acceder a archivos fuera de los directorios privados de la aplicación. En iOS y web, esto siempre devuelve 'concedido' ya que no se necesitan permisos especiales. |
Ejemplos
requestFileSystem()
Solicite un sistema de archivos.
import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';
const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);
resolveLocalFileSystemURL()
Resuelva 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()
Obtenga una entrada de archivo.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);
getDirectory()
Obtenga una entrada de directorio.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);
readFile()
Lea 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()
Lea un archivo como una URL de datos (base64 con prefijo de tipo 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 básicos. Los ayudantes de escucha y versión, y la plena contratación de cada método, se documentan en el repositorio de GitHub.
devuelve un manejador. Llame
addListener returns a handle. Llame handle.remove() cuando la pantalla se desmonta, o CapacitorFile.removeAllListeners() para eliminar todos los oyentes.
Referencia completa
Sigue adelante desde Using @capgo/capacitor-file
Si estás utilizando Usando @capgo/capacitor-file para planificar el almacenamiento y el manejo de archivos, conecta con @capgo/capacitor-archivo para los detalles de implementación en @capgo/capacitor-file Getting Started para los detalles de implementación en Empezar @capgo/capacitor-almacenamiento-de-datos-sqlite para los detalles de implementación en @capgo/capacitor-almacenamiento-de-datos-sqlite Usando @capgo/capacitor-almacenamiento-de-datos-sqlite para la capacidad nativa en Usando @capgo/capacitor-almacenamiento-de-datos-sqlite, y @capgo/capacitor-subidor para los detalles de implementación en @capgo/capacitor-subidor.