StorageManager: getDirectory() メソッド
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2023年3月以降、すべてのブラウザーで利用可能です。
安全なコンテキスト用: この機能は一部またはすべての対応しているブラウザーにおいて、安全なコンテキスト (HTTPS) でのみ利用できます。
メモ: この機能はウェブワーカー内で利用可能です。
getDirectory() は StorageManager インターフェイスのメソッドで、オリジンプライベートファイルシステム (OPFS) に保存されたディレクトリーとその中身へのアクセスを可能にする FileSystemDirectoryHandle オブジェクトへの参照を取得するために使用されます。
構文
getDirectory()
引数
なし。
返値
FileSystemDirectoryHandle のオブジェクトで解決される Promise を返します。
例外
SecurityErrorDOMException-
ストレージやメモリーの制約などの理由で、ブラウザーがリクエストされたディレクトリーをローカル OPFS に対応づけできない場合に発生します。また、一部のブラウザーでは、プライベートブラウジングモードで
getDirectory()が呼び出された場合にも発生します。 UnknownErrorDOMException-
プライベートブラウジングモードで
getDirectory()が呼び出されると、一部のブラウザーでこのエラーが発生することがあります。
例
以下の非同期イベントハンドラー関数は、ウェブワーカーの中にあります。メインスレッドからメッセージを受信すると、以下の動作をします。
getDirectory()を用いて OPFS のルートを表すFileSystemDirectoryHandleを取得し、変数rootに保存します。FileSystemDirectoryHandle.getFileHandle()を用いてファイルハンドルを取得します。FileSystemFileHandle.createSyncAccessHandle()を用いて同期式ファイルアクセスハンドルを作成します。- ファイルのサイズを取得し、格納するための
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() は、誤って非同期メソッドとして指定されており、一部のブラウザーの旧バージョンではこの方法で実装されています。しかし、これらのメソッドに対応している現在のすべてのブラウザーでは、同期メソッドとして実装されています。
仕様書
| 仕様書 |
|---|
| File System # dom-storagemanager-getdirectory |