StorageManager:getDirectory() 方法
Baseline 2023
Newly available
Since March 2023, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
备注: 此特性在 Web Worker 中可用。
StorageManager
接口的 getDirectory()
方法用于获取对 FileSystemDirectoryHandle
对象的引用,该对象允许访问存储在源私有文件系统(OPFS)中的目录及目录的内容。
语法
js
getDirectory()
参数
无。
返回值
一个兑现 FileSystemDirectoryHandle
对象的 Promise
。
异常
SecurityError
DOMException
-
如果用户代理无法将请求的目录映射到本地的 OPFS,则抛出此异常。
示例
以下异步事件处理函数包含在 Web Worker 中。从主线程收到消息后:
- 使用
getDirectory()
获取表示 OPFS 根目录的FileSystemDirectoryHandle
,并将其存储在root
变量中。 - 使用
FileSystemDirectoryHandle.getFileHandle()
获取文件句柄。 - 使用
FileSystemFileHandle.createSyncAccessHandle()
创建同步文件访问句柄。 - 获取文件的大小并创建一个
ArrayBuffer
来包含它。 - 读取和写入文件。
- 将更改保存到磁盘并关闭同步访问句柄。
js
onmessage = async (e) => {
// 从主线程检索发送到 worker 的消息
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();
};
备注:在规范的早期版本中,close()
、flush()
、getSize()
和 truncate()
被错误地指定为异步方法,并且某些较旧版本的浏览器以这种方式实现它们。然而,当前所有支持这些方法的浏览器都将它们实现为同步方法。
规范
Specification |
---|
File System Standard # dom-storagemanager-getdirectory |
浏览器兼容性
BCD tables only load in the browser