@capgo/capacitor-fileを使用
Capacitorファイルプラグインは、Cordova Fileプラグインと同様のファイルシステム操作を実装しています。
インストール
bun add @capgo/capacitor-file
bunx cap sync
bunx cap sync プラグインのネイティブcodeをコピーします。プラグインのアップグレード後は、再度実行してください。
Import
import { CapacitorFile } from '@capgo/capacitor-file';
APIの概要
| Method | 概要 |
|---|---|
requestFileSystem |
ファイルシステムを要求します。 |
resolveLocalFileSystemURL |
エントリを取得するためのファイルURLを解決します。 |
getFile |
ファイルエントリを取得します。 |
getDirectory |
ディレクトリエントリを取得します。 |
readFile |
テキストまたはbase64でファイルを読み取ります。 |
readAsDataURL |
base64にMIMEタイププレフィックスが付いたデータURLでファイルを読み取ります。 |
writeFile |
ファイルにデータを書き込みます。 |
appendFile |
ファイルにデータを追加します。 |
deleteFile |
ファイルを削除します。 |
mkdir |
ディレクトリを作成します。 |
rmdir |
ディレクトリを削除します。 |
readdir |
ディレクトリの内容を読みます。 |
stat |
ファイルまたはディレクトリのメタデータを取得します。 |
getMetadata |
ファイルまたはディレクトリのメタデータを取得します。stat()の別名です。 |
rename |
ファイルまたはディレクトリを名前変更または移動します。 |
move |
ファイルまたはディレクトリを移動します。rename()の別名です。 |
copy |
ファイルまたはディレクトリをコピーします。 |
exists |
ファイルまたはディレクトリが存在するかどうかを確認します。 |
getUri |
ファイルのURIを取得します。 |
truncate |
ファイルを指定したサイズに短縮します。 |
getDirectories |
すべてのファイルシステムのディレクトリを取得します。 |
getFreeDiskSpace |
ディスクの空き容量をバイト単位で取得します。 |
checkPermissions |
ファイル操作の現在の許可状況を確認します。Androidでは外部ストレージの許可を確認します。iOSとWebでは常に'許可されている'と表示されます。 |
requestPermissions |
ファイル操作のための許可を要求します。Androidの場合、この要求はアプリのプライベートディレクトリ外のファイルへのアクセスに必要な外部ストレージの許可を要求します。iOSとWebの場合、この許可は常に「許可」になります。 |
例
requestFileSystem()
ファイルシステムを要求します。
import { CapacitorFile, FileSystemType } from '@capgo/capacitor-file';
const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);
resolveLocalFileSystemURL()
ファイルURLをエントリに解決します。
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);
getFile()
ファイルエントリを取得します。
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);
getDirectory()
ディレクトリエントリを取得します。
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);
readFile()
テキストまたはbase64でファイルを読みます。
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);
readAsDataURL()
base64でMIMEタイププレフィックス付きのデータURLでファイルを読みます。
import { CapacitorFile } from '@capgo/capacitor-file';
const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);
上の表は24のコアメソッドをリストしています。リスナーとバージョンヘルパー、各メソッドのフルコントラクトは、__CAPGO_KEEP_0__リポジトリにドキュメントされています。 GitHub リポジトリ.
ハンドルを返します。呼び出し
addListener 許可 handle.remove() 画面がアンマウントされたとき、または CapacitorFile.removeAllListeners() リスナーのすべてをクリアする。
フルリファレンス
@capgo/capacitorファイルから続ける
使用中の @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-file から続けてください あなたが @capgo/capacitor-file を使用している場合 __CAPGO_KEEP_0__/__CAPGO_KEEP_1__-file と接続して capgo/capacitor-file の実装詳細 capgo/capacitor-file Capacitor File プラグインの使用を開始する for the implementation detail in Getting Started @capgo/capacitor-データストレージ-SQLite for the implementation detail in @capgo/capacitor-data-storage-sqlite @capgo/capacitorデータストレージ(SQLite) Capacitor-ファイルプラグインは、@capgo/capacitor-data-storage-sqliteというネイティブ機能を使用して、 @capgo/capacitor-アップローダー for the implementation detail in @capgo/capacitor-uploader