Saltare al contenuto principale
@capgo/capacitor-file File e archiviazione Sorgente aperta

File Plugin Capacitor

Plugin di sistema file completo per la lettura, scrittura e gestione di file e directory

Installa

bun add @capgo/capacitor-file bunx cap sync
pnpm o yarn npm
  • npm install @capgo/capacitor-file
  • pnpm add @capgo/capacitor-file
  • yarn add @capgo/capacitor-file

Guida

Come utilizzare File in Capacitor

Testa sul dispositivo

Scarica l'app Capgo, poi scansa il codice QR code.

Collegamento QR di anteprima del plugin File code

Utilizza @capgo/capacitor-file

Capacitor Plugin File Implementa operazioni sul sistema di file simili al plugin File di Cordova.

Installa

bun add @capgo/capacitor-file
bunx cap sync

bunx cap sync copia il code nativo del plugin nei tuoi progetti nativi. Esegui nuovamente dopo ogni aggiornamento del plugin.

Importa

import { CapacitorFile } from '@capgo/capacitor-file';

Vedi API in un colpo d'occhio

Metodo Descrizione
requestFileSystem Richiedi un sistema di file.
resolveLocalFileSystemURL Risolve un URL di file a un'entry.
getFile Ottieni un'entry di file.
getDirectory Ottieni un'entry di directory.
readFile Lega un file come testo o base64.
readAsDataURL Lega un file come un URL di dati (base64 con prefisso MIME).
writeFile Scrivi dati in un file.
appendFile Aggiungi dati a un file.
deleteFile Cancella un file.
mkdir Crea una directory.
rmdir Cancella una directory.
readdir Leggi i contenuti del directory.
stat Ottieni metadati su un file o directory.
getMetadata Ottieni metadati su un file o directory. Alias per stat().
rename Rinomina o sposta un file o directory.
move Sposta un file o directory. Alias per rename().
copy Copia un file o directory.
exists Controlla se un file o directory esiste.
getUri Ottieni l'URI per un file.
truncate Tronca un file a una dimensione specificata.
getDirectories Ottieni tutti i directory del sistema file noti.
getFreeDiskSpace Ottieni lo spazio libero del disco in byte.
checkPermissions Controlla lo stato di permesso corrente per le operazioni sui file. Su Android, questo controlla le autorizzazioni di archiviazione esterna. Su iOS e web, questo restituisce sempre 'concesso' poiché non sono necessarie autorizzazioni speciali.
requestPermissions Richiedi le autorizzazioni per le operazioni sui file. Su Android, ciò richiede le autorizzazioni di archiviazione esterna necessarie per accedere ai file al di fuori dei directory privati dell'app. Su iOS e web, questo restituisce sempre 'concesso' poiché non sono necessarie autorizzazioni speciali.

Esempi

requestFileSystem()

Richiedi un sistema di file.

import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';

const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);

resolveLocalFileSystemURL()

Risolve una URL di file in un'entry.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);

getFile()

Ottieni un'entry di file.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);

getDirectory()

Ottieni un'entry di directory.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);

readFile()

Leggi un file come testo o base64.

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);

readAsDataURL()

Leggi un file come una URL dei dati (base64 con prefisso MIME).

import { CapacitorFile } from '@capgo/capacitor-file';

const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);

I metodi elencati nella tabella sopra sono 24. I listener e gli aiuti per la versione, nonché il contratto completo di ogni metodo, sono documentati nella repository GitHub.

Ascolta gli eventi

addListener restituisce un handle. Chiama handle.remove() quando lo schermo viene smontato, o CapacitorFile.removeAllListeners() per cancellare tutti gli ascoltatori.

Tutte le informazioni

Continua da Utilizzo di @capgo/capacitor-file

Se stai utilizzando Utilizzo di @capgo/capacitor-file per pianificare lo storage e la gestione dei file, collegalo con @capgo/capacitor-file per i dettagli di implementazione in @capgo/capacitor-file, Getting Started per i dettagli di implementazione in Avvio, @capgo/capacitor-archiviazione-dati-sqlite per i dettagli di implementazione in @capgo/capacitor-archiviazione-dati-sqlite, Utilizzare @capgo/capacitor-archiviazione-dati-sqlite per la capacità nativa in Utilizzare @capgo/capacitor-archiviazione-dati-sqlite, e uploader per capgo-capacitor per il dettaglio di implementazione in @capgo/capacitor-uploader.

FAQ

Domande frequenti sul plugin File

Come posso installare il plugin File in un'app Capacitor?

Esegui "bun add @capgo/capacitor-file" (o "npm install @capgo/capacitor-file"), quindi esegui "bunx cap sync" per far assorbire i progetti iOS e Android del codice nativo code. Importalo da "@capgo/capacitor-file" nella tua app code.

Funziona @capgo/capacitor-file con React, Vue e Angular?

Sì. File è un pacchetto Capacitor, quindi funziona con qualsiasi framework web che esegue all'interno di Capacitor, compresi Ionic, React, Vue, Angular, Svelte e JavaScript puro.

Qual è la versione di Capacitor supportata da @capgo/capacitor-file?

Capgo plugin seguono la versione maggiore di Capacitor: utilizzare la versione maggiore del plugin che corrisponde alla tua versione maggiore di Capacitor (ad esempio plugin v8 con Capacitor 8). La tabella di compatibilità nella GitHub README elenca le versioni mantenute.

È @capgo/capacitor-file gratuito e open source?

Sì. Il codice sorgente di code è pubblico su GitHub all'indirizzo https://github.com/Cap-go/capacitor-file/ e il pacchetto è gratuito per l'installazione da npm. I rapporti di bug e le richieste di pull sono graditi.

Posso aggiornare code che utilizza File senza una revisione dell'App Store?

L'installazione o l'aggiornamento del plugin modifica il code nativo, quindi richiede una nuova costruzione del negozio. Dopo di che, le modifiche JavaScript, HTML e CSS che chiamano il plugin possono essere distribuite immediatamente con Capgo live updates.

Invia modifiche ai file senza attendere la revisione dell'app

Una volta che il plugin è presente nella tua store build, Capgo le aggiornamenti live inviano le tue modifiche JavaScript, HTML e CSS agli utenti in pochi minuti.

Inizia con Capgo