@capgo/capacitor-file

Plugin de sistema de archivos completo para leer, escribir y gestionar archivos y directorios

Resumen

Plugin de sistema de archivos completo para leer, escribir y gestionar archivos y directorios

Empieza con requestFileSystem() y los demás métodos principales detallados abajo.

Soporte de plataformas

Plataforma	Soporte	Notas
iOS	Sí	Nativo
Android	Sí	Nativo
Web	Sí	APIs de almacenamiento del navegador

Funcionalidades principales

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.

Público API

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 de tipo MIME).
`writeFile`	Escribir datos en un archivo.
`appendFile`	Añade datos a un archivo.
`deleteFile`	Elimina un archivo.
`mkdir`	Crea un directorio.
`rmdir`	Elimina un directorio.
`readdir`	Lee el contenido de un directorio.
`stat`	Obtén metadatos de un archivo o directorio.
`getMetadata`	Obtén metadatos de un archivo o directorio. Alias de stat().
`rename`	Renombra o mueve un archivo o directorio.
`move`	Mueve un archivo o directorio. Alias de rename().
`copy`	Copia un archivo o directorio.
`exists`	Comprueba si un archivo o directorio existe.
`getUri`	Obtén 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.
`addListener`	Escucha los eventos de progreso de lectura.
`addListener`	Escucha los eventos de progreso de escritura.
`removeAllListeners`	Elimina todos los listeners de eventos.
`getPluginVersion`	Obtén la versión del plugin.
`checkPermissions`	Comprueba el estado actual de los permisos para operaciones de archivos. En Android, comprueba 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.

Valores de referencia

Usa estos valores al elegir una ubicación de almacenamiento, escribir texto codificado o manejar errores de archivos.

Directorios

Valor	El usuario encontrará
`DOCUMENTS`	Documentos persistentes visibles para el usuario. En Android, esto apunta al directorio de archivos de la app.
`DATA`	Datos privados y persistentes de la app.
`LIBRARY`	Datos persistentes de la app no visibles para el usuario. En Android, esto apunta al directorio de archivos de la app.
`CACHE`	Datos de caché temporales que el SO puede borrar.
`EXTERNAL`	Raíz del almacenamiento externo de Android, como una SD o almacenamiento externo compartido.
`EXTERNAL_STORAGE`	Directorio de datos del almacenamiento externo de Android.
`APPLICATION`	Directorio de solo lectura del bundle o assets de la aplicación.

Codificaciones

Valor	Usa
`utf8`	Texto en UTF-8.
`ascii`	Texto en ASCII.
`utf16`	Texto en UTF-16.

Códigos de error de archivo

Valor	Code	Significado
`NOT_FOUND_ERR`	`1`	No se encontró el archivo o directorio.
`SECURITY_ERR`	`2`	La operación fue bloqueada por reglas de seguridad o permisos.
`ABORT_ERR`	`3`	La operación fue abortada.
`NOT_READABLE_ERR`	`4`	No se puede leer el archivo o directorio.
`ENCODING_ERR`	`5`	La codificación es inválida o no es compatible.
`NO_MODIFICATION_ALLOWED_ERR`	`6`	El destino no se puede modificar.
`INVALID_STATE_ERR`	`7`	El objeto no está en un estado válido para la operación.
`SYNTAX_ERR`	`8`	La sintaxis de la ruta o de la entrada es inválida.
`INVALID_MODIFICATION_ERR`	`9`	El cambio solicitado no es válido para el destino.
`QUOTA_EXCEEDED_ERR`	`10`	Se ha excedido la cuota de almacenamiento.
`TYPE_MISMATCH_ERR`	`11`	El tipo de valor no coincide con el tipo esperado.
`PATH_EXISTS_ERR`	`12`	La ruta de destino ya existe.

Fuente de verdad

Esta referencia se sincroniza desde src/definitions.ts en capacitor-file.

Continúa con @capgo/capacitor-file

Si estás usando @capgo/capacitor-file para planificar el almacenamiento y la gestión de archivos, conéctalo con Uso de @capgo/capacitor-file para la capacidad nativa en el uso de @capgo/capacitor-file, @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 funcionalidad nativa en Uso de @capgo/capacitor-data-storage-sqlite, @capgo/capacitor-uploader para los detalles de implementación en @capgo/capacitor-uploader, y Uso de @capgo/capacitor-uploader para la capacidad nativa al usar @capgo/capacitor-uploader.