Langsung ke konten utama
@capgo/capacitor-file File & Penyimpanan Open source

File plugin Capacitor

Plugin sistem file lengkap untuk membaca, menulis, dan mengelola file serta direktori

Instal

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

Panduan

Cara menggunakan File di Capacitor

Menggunakan @capgo/capacitor-file

Capacitor File Plugin mengimplementasikan operasi sistem file yang mirip dengan plugin File Cordova.

Instal

bun add @capgo/capacitor-file
bunx cap sync

bunx cap sync menyalin code native plugin ke dalam proyek native Anda. Jalankan kembali setiap kali melakukan upgrade plugin.

Impor

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

Sekilas tentang API

Metode Deskripsi
requestFileSystem Meminta file system.
resolveLocalFileSystemURL Me-resolve URL file menjadi entry.
getFile Mendapatkan entry file.
getDirectory Dapatkan entri direktori.
readFile Baca file sebagai teks atau base64.
readAsDataURL Baca file sebagai data URL (base64 dengan prefix MIME type).
writeFile Menulis data ke dalam file.
appendFile Tambahkan data ke file.
deleteFile Hapus file.
mkdir Buat direktori.
rmdir Hapus direktori.
readdir Baca isi direktori.
stat Dapatkan metadata file atau direktori.
getMetadata Dapatkan metadata file atau direktori. Alias untuk stat().
rename Ubah nama atau pindahkan file atau direktori.
move Pindahkan file atau direktori. Alias untuk rename().
copy Salin file atau direktori.
exists Cek apakah file atau direktori ada.
getUri Dapatkan URI file.
truncate Potong file ke ukuran tertentu.
getDirectories Dapatkan semua direktori file system yang diketahui.
getFreeDiskSpace Dapatkan sisa ruang disk dalam byte.
checkPermissions Cek status izin operasi file saat ini. Di Android, ini mengecek izin storage eksternal. Di iOS dan web, ini selalu mengembalikan 'granted' karena tidak perlu izin khusus.
requestPermissions Minta izin untuk operasi file. Di Android, ini meminta izin storage eksternal yang dibutuhkan untuk mengakses file di luar direktori privat aplikasi. Di iOS dan web, ini selalu mengembalikan 'granted' karena tidak perlu izin khusus.

Contoh

requestFileSystem()

Meminta file system.

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

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

resolveLocalFileSystemURL()

Me-resolve URL file menjadi entry.

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

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

getFile()

Mendapatkan entry file.

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

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

getDirectory()

Dapatkan entri direktori.

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

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

readFile()

Baca file sebagai teks atau base64.

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

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

readAsDataURL()

Baca file sebagai data URL (base64 dengan prefix MIME type).

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

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

Tabel di atas mencantumkan 24 metode inti. Helper listener dan versi, serta kontrak lengkap tiap metode, didokumentasikan di repositori GitHub.

Mendengarkan event

addListener mengembalikan sebuah handle. Panggil handle.remove() saat layar di-unmount, atau CapacitorFile.removeAllListeners() untuk menghapus semua listener.

Referensi lengkap

Lanjutkan dari Menggunakan @capgo/capacitor-file

Jika Anda menggunakan Menggunakan @capgo/capacitor-file untuk merencanakan penyimpanan dan penanganan file, hubungkan dengan @capgo/capacitor-file untuk detail implementasi di @capgo/capacitor-file, Panduan Memulai untuk detail implementasi di Getting Started, @capgo/capacitor-data-storage-sqlite untuk detail implementasi di @capgo/capacitor-data-storage-sqlite, Menggunakan @capgo/capacitor-data-storage-sqlite untuk kemampuan native di bagian Menggunakan @capgo/capacitor-data-storage-sqlite, dan @capgo/capacitor-uploader untuk detail implementasi di @capgo/capacitor-uploader.

FAQ

FAQ plugin File

Bagaimana cara menginstal plugin File di aplikasi Capacitor?

Jalankan "bun add @capgo/capacitor-file" (atau "npm install @capgo/capacitor-file"), lalu jalankan "bunx cap sync" agar proyek iOS dan Android mengambil code native. Impor dari "@capgo/capacitor-file" di code aplikasi Anda.

Apakah @capgo/capacitor-file bekerja dengan React, Vue, dan Angular?

Ya. File adalah paket Capacitor, jadi bekerja dengan framework web apa pun yang berjalan di dalam Capacitor, termasuk Ionic, React, Vue, Angular, Svelte, dan JavaScript murni.

Versi Capacitor mana yang didukung oleh @capgo/capacitor-file?

Plugin Capgo mengikuti versi mayor Capacitor: gunakan versi mayor plugin yang sesuai dengan versi mayor Capacitor Anda (contoh: plugin v8 dengan Capacitor 8). Tabel kompatibilitas di README GitHub mencantumkan versi yang masih di-maintain.

Apakah @capgo/capacitor-file gratis dan open source?

Ya. code sumber tersedia di GitHub pada https://github.com/Cap-go/capacitor-file/ dan paketnya gratis untuk diinstal dari npm. Laporan bug dan pull request disambut baik.

Bisakah saya memperbarui code yang menggunakan File tanpa review App Store?

Instalasi atau upgrade plugin akan mengubah native code, jadi butuh build store baru. Setelah itu, perubahan JavaScript, HTML, dan CSS yang memanggil plugin bisa langsung dikirim lewat live updates Capgo.

Rilis perubahan file tanpa menunggu review aplikasi

Setelah plugin ada di build store Anda, live updates Capgo akan mengirim perubahan JavaScript, HTML, dan CSS ke pengguna dalam hitungan menit.

Mulai dengan Capgo