FileSystemSyncAccessHandle

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since ⁨2023年3月⁩.

安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。

File System Access API の FileSystemSyncAccessHandle インターフェイスは、ファイルシステムのエントリーを扱う同期式のハンドルを表します。ファイルの読み書きにおける同期式であるという性質は、WebAssembly などの非同期操作が高いオーバーヘッドに繋がる状況における重要なメソッドのパフォーマンスを高めることができます。

このクラスは、それ用の Web Workers 内でオリジンプライベートファイルシステムにあるファイルを操作するときのみアクセスできます。

このインターフェイスは FileSystemFileHandle.createSyncAccessHandle() メソッド経由でアクセスされます。

インスタンスプロパティ

なし

インスタンスメソッド

close(): 開かれている同期式ファイルハンドルを閉じます。これ以降操作をできなくし、ファイルハンドルに対応するファイルにかけた排他的ロックを解除します。
flush(): ハンドルに対応するファイルに対し write() メソッドにより行われたすべての変更をディスクに保存します。
getSize(): ハンドルに対応するファイルのサイズをバイト単位で返します。
read(): ハンドルに対応するファイルの内容を指定のバッファーに読み込みます。オフセットを指定することもできます。
truncate(): ハンドルに対応するファイルのサイズを指定のバイト数にします。
write(): 指定のバッファーの内容をハンドルに対応するファイルに書き込みます。オフセットを指定することもできます。

例

以下の非同期のイベントハンドラー関数は、Web Worker の中にあります。メインスレッドからメッセージを受信すると、以下の動作をします。

同期式ファイルアクセスハンドルを作成します。
ファイルのサイズを取得し、格納用の ArrayBuffer を作成します。
ファイルの内容をバッファーに読み込みます。
メッセージをエンコードし、ファイルの終端に書き込みます。
変更をディスクに書き込み、アクセスハンドルを閉じます。

onmessage = async (e) => {
  // メインスクリプトからの処理対象のメッセージを取得する
  const message = e.data;

  // draft ファイルのハンドルを取得する
  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();
};

メモ: 仕様書の以前のバージョンでは、close()・flush()・getSize()・truncate() は誤って非同期のメソッドとされていました。これは現在は変更されていますが、まだ非同期バージョンをサポートしているブラウザーもあります。