Guide
Comment utiliser le fichier dans Capacitor
Utilisez @capgo/capacitor-file
Capacitor implémente le plugin de fichiers système, similaire au plugin Cordova File.
Installer
bun add @capgo/capacitor-file
bunx cap sync
bunx cap sync copie le plugin natif code dans vos projets natifs. Exécutez-l’à nouveau après chaque mise à niveau du plugin.
Importer
import { CapacitorFile } from '@capgo/capacitor-file';
API en un coup d'œil
| Méthode | Description |
|---|---|
requestFileSystem |
Demander un système de fichiers. |
resolveLocalFileSystemURL |
Résoudre une URL de fichier en entrée. |
getFile |
Obtenir une entrée de fichier. |
getDirectory |
Obtenir une entrée de répertoire. |
readFile |
Lire un fichier en texte ou en base64. |
readAsDataURL |
Lire un fichier sous forme de URL de données (base64 avec préfixe MIME). |
writeFile |
Écrire des données dans un fichier. |
appendFile |
Ajouter des données à un fichier. |
deleteFile |
Supprimer un fichier. |
mkdir |
Créer un répertoire. |
rmdir |
Supprimer un répertoire. |
readdir |
Lire les contenus du répertoire. |
stat |
Obtenir les métadonnées d'un fichier ou d'un répertoire. |
getMetadata |
Obtenir les métadonnées d'un fichier ou d'un répertoire. Alias pour stat(). |
rename |
Renommer ou déplacer un fichier ou un répertoire. |
move |
Déplacer un fichier ou un répertoire. Alias pour rename(). |
copy |
Copier un fichier ou un répertoire. |
exists |
Vérifier si un fichier ou un répertoire existe. |
getUri |
Obtenir l'URI pour un fichier. |
truncate |
Tronquer un fichier jusqu'à une taille spécifiée. |
getDirectories |
Get all known file system directories. |
getFreeDiskSpace |
Obtenir l'espace disque libre en octets. |
checkPermissions |
Vérifier l'état de permission actuel pour les opérations de fichiers. Sur Android, cela vérifie les permissions d'accès externe. Sur iOS et web, cela retourne toujours 'accordé' car aucune permission spéciale n'est nécessaire. |
requestPermissions |
Demander les permissions pour les opérations de fichier. Sur Android, cela demande les permissions d'accès externe au stockage nécessaire pour accéder aux fichiers en dehors des répertoires privés de l'application. Sur iOS et web, cela retourne toujours « autorisé » car aucune permission spéciale n'est nécessaire. |
Exemples
requestFileSystem()
Demander un système de fichiers.
import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';
const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);
resolveLocalFileSystemURL()
Résoudre une URL de fichier en entrée.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);
getFile()
Obtenir une entrée de fichier.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);
getDirectory()
Obtenir une entrée de répertoire.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);
readFile()
Lire un fichier en texte ou en base64.
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);
readAsDataURL()
Lire un fichier sous forme de URL de données (base64 avec préfixe MIME).
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);
La table ci-dessus liste les 24 méthodes de base. Les helpers d'écouteur et de version, ainsi que la pleine convention de chaque méthode, sont documentés dans le répertoire GitHub.
Écouter les événements
addListener retourne un gestionnaire. Appelez handle.remove() lorsque l'écran est démonté, ou CapacitorFile.removeAllListeners() pour supprimer tous les écouteurs.
Référence complète
Continuez à partir de l'utilisation de @capgo/capacitor-file
la référence __CAPGO_KEEP_0__ Utilisation de @capgo/capacitor-fichier pour planifier le stockage et la gestion des fichiers, connectez-l’avec L'utilisation de @capgo/capacitor-file pour le détail d'implémentation dans @capgo/capacitor-fichier Prise en main pour les détails d'implémentation dans Prise en main, @capgo/capacitor-stockage-de-données-sqlite pour les détails d'implémentation dans @capgo/capacitor-stockage-de-données-sqlite, Utilisation de @capgo/capacitor-stockage-de-données-sqlite pour la capacité native dans Utilisation de @capgo/capacitor-stockage-de-données-sqlite, et @capgo/capacitor-téléchargeur pour les détails d'implémentation dans @capgo/capacitor-téléchargeur.