FileSystemSyncAccessHandle
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2023年3月以降、すべてのブラウザーで利用可能です。
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
メモ: この機能は専用ウェブワーカー内でのみ利用可能です。
FileSystemSyncAccessHandle はファイルシステム API のインターフェイスで、ファイルシステムの項目を同期的に操作するハンドルを表します。
このクラスには、専用ウェブワーカー内からのみアクセスできます。これは、このクラスのメソッドがメインスレッドの実行をブロックしないようにするためです。対象となるのは、エンドユーザーには見えないオリジンプライベートファイルシステム内のファイルです。
その結果、これらのメソッドは、ユーザーに表示されるファイルシステム内のファイルを操作するメソッドと同じセキュリティチェックの対象にならず、パフォーマンスが大幅に向上します。そのため、SQLite (英語) データベースの変更など、大規模なファイル更新に適しています。
このインターフェイスは FileSystemFileHandle.createSyncAccessHandle() メソッド経由でアクセスされます。
メモ:
仕様書の以前のバージョンでは、close()、flush()、getSize()、truncate() は誤って非同期メソッドとして規定されていました。一部のブラウザーの古いバージョンでは、これらのメソッドがそのように実装されています。しかし、これらのメソッドに対応する現行のブラウザーでは、すべて同期メソッドとして実装されています。
インスタンスプロパティ
なし。
インスタンスメソッド
close()-
開かれている同期式ファイルハンドルを閉じます。これ以降操作をできなくし、ファイルハンドルに対応するファイルにかけた排他的ロックを解除します。
flush()-
ハンドルに対応するファイルに対し
write()メソッドにより行われたすべての変更をディスクに保存します。 getSize()-
ハンドルに対応するファイルのサイズをバイト単位で返します。
read()-
ハンドルに対応するファイルの内容を指定のバッファーに読み込みます。オフセットを指定することもできます。
truncate()-
ハンドルに対応するファイルのサイズを指定のバイト数にします。
write()-
指定のバッファーの内容をハンドルに対応するファイルに書き込みます。オフセットを指定することもできます。
例
以下の非同期のイベントハンドラー関数は、Web Worker の中にあります。メインスレッドからメッセージを受信すると、以下の動作をします。
- 同期式ファイルアクセスハンドルを作成します。
- ファイルのサイズを取得し、格納用の
ArrayBufferを作成します。 - ファイルの内容をバッファーに読み込みます。
- メッセージをエンコードし、ファイルの終端に書き込みます。
- 変更をディスクに書き込み、アクセスハンドルを閉じます。
onmessage = async (e) => {
// メインスクリプトからの処理対象のメッセージを取得する
const message = e.data;
// 下書きファイルのハンドルを取得する
const root = await navigator.storage.getDirectory();
const draftHandle = await root.getFileHandle("draft.txt", { create: true });
// 同期式アクセスハンドルを取得する
const accessHandle = await draftHandle.createSyncAccessHandle();
// ファイルのサイズを得る
const fileSize = accessHandle.getSize();
// ファイルの内容をバッファーに読み込む
const buffer = new DataView(new ArrayBuffer(fileSize));
const readBuffer = accessHandle.read(buffer, { at: 0 });
// メッセージをファイルの終端に書き込む
const encoder = new TextEncoder();
const encodedMessage = encoder.encode(message);
const writeBuffer = accessHandle.write(encodedMessage, { at: readBuffer });
// 変更をディスクに書き込む
accessHandle.flush();
// 完了したら、常に FileSystemSyncAccessHandle を閉じる
accessHandle.close();
};
仕様書
| 仕様書 |
|---|
| File System> # api-filesystemsyncaccesshandle> |