FileSystemSyncAccessHandle.flush()
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) でのみ利用できます。
FileSystemSyncAccessHandle インターフェイスの flush() メソッドは、ハンドルに対応するファイルに write() メソッドにより行われたすべての変更をディスクに保存します。
心に留めておくべきこととして、このメソッドを呼ぶ必要があるのは変更のディスクへの書き込みを特定のタイミングで行う必要があるときのみです。そうでなければ、下層の OS に任せて都合のいいときに処理させることができ、ほとんどの場合はこれでいいでしょう。
構文
js
flush()
引数
なし
返値
undefined で解決する Promise を返します。
例外
なし
例
以下の非同期のイベントハンドラーは、Web Worker の中にあります。メインスレッドからのメッセージを受信すると、以下の動作をします。
- 同期式ファイルアクセスハンドルを作成します。
- ファイルのサイズを取得し、格納用の
ArrayBufferを作成します。 - ファイルの内容をバッファーに読み込みます。
- メッセージをエンコードし、ファイルの終端に書き込みます。
- 変更をディスクに書き込み、アクセスハンドルを閉じます。
js
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() は誤って非同期メソッドとされていました。これは現在では変更されていますが、まだ非同期バージョンをサポートしているブラウザーもあります。
仕様書
| Specification |
|---|
| File System # api-filesystemsyncaccesshandle-flush |
ブラウザーの互換性
Loading…