FileSystemSyncAccessHandle: flush() メソッド
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2023年3月以降、すべてのブラウザーで利用可能です。
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
メモ: この機能は専用ウェブワーカー内でのみ利用可能です。
flush() は FileSystemSyncAccessHandle インターフェイスのメソッドで、ハンドルに対応するファイルに write() メソッドにより行われたすべての変更をディスクに保存します。
このメソッドを呼び出す必要があるのは、変更を特定のタイミングでディスクに反映させる必要がある場合だけです。そうでなければ、ほとんどの場合、下層のオペレーティングシステムが適切なタイミングで処理するよう任せておけば問題ありません。
メモ:
仕様書の以前のバージョンでは、close()、flush()、getSize()、truncate() は誤って非同期メソッドとして規定されていました。一部のブラウザーの古いバージョンでは、これらのメソッドがそのように実装されています。しかし、これらのメソッドに対応する現行のブラウザーでは、すべて同期メソッドとして実装されています。
構文
js
flush()
引数
なし。
返値
なし (undefined)。
例外
InvalidStateErrorDOMException-
関連するアクセスハンドルがすでに閉じられている場合に発生します。
例
以下の非同期のイベントハンドラーは、ウェブワーカーの中にあります。メインスレッドからのメッセージを受信すると、以下の動作をします。
- 同期式ファイルアクセスハンドルを作成します。
- ファイルのサイズを取得し、格納用の
ArrayBufferを作成します。 - ファイルの内容をバッファーに読み込みます。
- メッセージをエンコードし、ファイルの終端に書き込みます。
- 変更をディスクに書き込み、アクセスハンドルを閉じます。
js
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-flush> |