Zum Hauptinhalt springen
@capgo/capacitor-datei Dateien und Speicher offene Quelle

Datei Capacitor Plugin

Vollwertiges Dateisystem-Plugin für das Lesen, Schreiben und Verwalten von Dateien und Verzeichnissen

Installieren

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

Anleitung

Wie man File in Capacitor verwendet

Auf Gerät testen

Laden Sie die Capgo-App herunter, dann scannen Sie die QR-Code code.

QR-code für die Datei-Plugin-Vorschau

@capgo/capacitor-datei verwenden

Capacitor Datei-Plugin Implementiert Dateisystemoperationen ähnlich dem Cordova File-Plugin.

Installieren

bun add @capgo/capacitor-file
bunx cap sync

bunx cap sync kopiert die native code des Plugins in Ihre native Projekte. Führen Sie es erneut aus, nachdem Sie jedes Plugin aktualisiert haben.

Importieren

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

API im Überblick

Methode Beschreibung
requestFileSystem Einen Dateisystem anfordern.
resolveLocalFileSystemURL Eine Datei-URL auf ein Eintrags-Objekt auflösen.
getFile Ein Dateieintrags-Objekt abrufen.
getDirectory Ein Verzeichniseintrags-Objekt abrufen.
readFile Eine Datei als Text oder Base64 lesen.
readAsDataURL Ein Datei als Daten-URL lesen (base64 mit MIME-Typ-Präfix).
writeFile Daten in eine Datei schreiben.
appendFile Daten an eine Datei anhängen.
deleteFile Eine Datei löschen.
mkdir Ein Verzeichnis erstellen.
rmdir Ein Verzeichnis löschen.
readdir Verzeichnisinhalt lesen.
stat Metadaten eines Dateisystems oder einer Datei abrufen.
getMetadata Metadaten eines Dateisystems oder einer Datei abrufen. Alias für stat().
rename Rename or move a file or directory.
move Eine Datei oder ein Verzeichnis verschieben. Alias für rename().
copy Eine Datei oder ein Verzeichnis kopieren.
exists Check if a file or directory exists.
getUri Den URI einer Datei abrufen.
truncate Eine Datei auf eine bestimmte Größe reduzieren.
getDirectories Alle bekannten Dateisystem-Verzeichnisse abrufen.
getFreeDiskSpace Get the free disk space in bytes.
checkPermissions Überprüfen, ob die aktuellen Berechtigungen für Dateibearbeitungen erlaubt sind. Auf Android überprüft dies die Berechtigungen für externe Speicher. Auf iOS und Web wird immer 'erlaubt' zurückgegeben, da keine besonderen Berechtigungen erforderlich sind.
requestPermissions Berechtigungen für Dateibearbeitungen anfordern. Auf Android wird hier die Auflistung der externen Speicherberechtigungen angefordert, die zum Zugriff auf Dateien außerhalb der privaten Verzeichnisse des Apps erforderlich sind. Auf iOS und Web wird immer 'erlaubt' zurückgegeben, da keine besonderen Berechtigungen erforderlich sind.

Beispiele

requestFileSystem()

Ein Dateisystem anfordern

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

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

resolveLocalFileSystemURL()

Eine Datei-URL auf eine Eintrags-Objekt auflösen

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

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

getFile()

Ein Dateieintrag erhalten

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

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

getDirectory()

Ein Verzeichniseintrag erhalten

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

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

readFile()

Eine Datei als Text oder Base64 lesen

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

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

readAsDataURL()

Eine Datei als Daten-URL (Base64 mit MIME-Typ-Präfix) lesen

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

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

Die folgende Tabelle listet die 24 Kernmethoden auf. Helfer für Listener und Versionen sowie die vollständige Vertragsstruktur jeder Methode sind im GitHub-Repository.

Auf Ereignisse hören

addListener eine Verbindung zurückgeben handle.remove() Wenn sich das Bildschirmfenster auflöst oder CapacitorFile.removeAllListeners() um alle Listener zu löschen.

Vollständige Referenz

Weitermachen von @capgo/capacitor-Datei

Fortsetzen von Using @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-file Wenn Sie Using @capgo/capacitor-file um Speicher und Dateihandling zu planen, verbinden Sie es mit @capgo/capacitor-Datei @capgo/capacitor-file für die Implementierungsdetails in @capgo/capacitor-file, Zur Einführung zur Implementierungsdetail in Zur Einführung @capgo/capacitor-Speicherung in einer SQLite-Datenbank zur Implementierungsdetail in @capgo/capacitor-Speicherung in einer SQLite-Datenbank Verwendung von @capgo/capacitor-Daten-Speicher-SQLite zur nativen Fähigkeit in @capgo/capacitor-Speicherung in einer SQLite-Datenbank verwenden und @capgo/capacitor-Uploader für die Implementierungsdetails in @capgo/capacitor-Uploader.

FAQ

Häufig gestellte Fragen

Wie installiere ich die Datei-Plugin in einer Capacitor-Anwendung?

Run "bun add @capgo/capacitor-file" (or "npm install @capgo/capacitor-file"), then run "bunx cap sync" so the iOS and Android projects pick up the native code. Import it from "@capgo/capacitor-file" in your app code.

Funktioniert @capgo/capacitor-file mit React, Vue und Angular?

Yes. File is a Capacitor package, so it works with any web framework that runs inside Capacitor, including Ionic, React, Vue, Angular, Svelte and plain JavaScript.

Welche Capacitor-Version unterstützt @capgo/capacitor-Datei?

Capgo-Plugins folgen der Capacitor-Major-Version: Wählen Sie die Plugin-Major-Version, die Ihrem Capacitor-Major-Version entspricht (z.B. Plugin v8 mit Capacitor 8). Die Kompatibilitäts-Tabelle im GitHub-README enthält die unterstützten Versionen.

Ist @capgo/capacitor-Datei kostenlos und Open-Source?

Ja. Der Quellcode von code ist öffentlich auf GitHub unter https://github.com/Cap-go/capacitor-Datei/ verfügbar und das Paket kann kostenlos installiert werden von npm. Bug-Berichte und Pull-Anfragen sind willkommen.

Kann ich code mit File aktualisieren, ohne eine App Store-Bewertung abzuwarten?

Die Installation oder das Upgrade des Plugins ändert die native code, daher ist eine neue Store-Build erforderlich. Anschließend können JavaScript-, HTML- und CSS-Änderungen, die den Plugin aufrufen, sofort mit Capgo-Live-Updates verschickt werden.

Schicken Sie Datei-Änderungen ohne auf eine App-Überprüfung zu warten

Sobald das Plugin in Ihrem Store-Build ist, Capgo Live-Updates drücken Ihre JavaScript-, HTML- und CSS-Änderungen an die Benutzer in Minuten.

Starten Sie mit Capgo