FileSystemSyncAccessHandle: flush() 方法

Baseline 已广泛支持

此功能已成熟,并可在许多设备和浏览器版本上运行。自 2023 年 3 月以来,它已在各种浏览器中可用。

安全上下文: 此功能仅在安全上下文(HTTPS)中可用,且支持此功能的浏览器数量有限。

注意:此功能仅在 专用 Web Worker 中可用。

FileSystemSyncAccessHandle 接口的 flush() 方法会将通过 write() 方法对关联文件所做的任何更改持久化到磁盘。

请注意,只有当您需要在特定时间将更改提交到磁盘时,才需要调用此方法。否则,您可以让底层操作系统在认为合适时处理此问题,这在大多数情况下应该是可以的。

注意: 在规范的早期版本中,close()flush()getSize()truncate() 被错误地指定为异步方法,并且某些旧版本的浏览器也以这种方式实现它们。然而,所有当前支持这些方法的浏览器都将它们实现为同步方法。

语法

js
flush()

参数

无。

返回值

无(undefined)。

异常

InvalidStateError DOMException

如果关联的访问句柄已关闭,则会抛出此错误。

示例

以下异步事件处理函数包含在 Web Worker 中。在接收到主线程的消息后,它会:

  • 创建一个同步文件访问句柄。
  • 获取文件大小并创建一个 ArrayBuffer 来存储它。
  • 将文件内容读入缓冲区。
  • 对消息进行编码并将其写入文件末尾。
  • 将更改持久化到磁盘并关闭访问句柄。
js
onmessage = async (e) => {
  // Retrieve message sent to work from main script
  const message = e.data;

  // Get handle to draft file
  const root = await navigator.storage.getDirectory();
  const draftHandle = await root.getFileHandle("draft.txt", { create: true });
  // Get sync access handle
  const accessHandle = await draftHandle.createSyncAccessHandle();

  // Get size of the file.
  const fileSize = accessHandle.getSize();
  // Read file content to a buffer.
  const buffer = new DataView(new ArrayBuffer(fileSize));
  const readBuffer = accessHandle.read(buffer, { at: 0 });

  // Write the message to the end of the file.
  const encoder = new TextEncoder();
  const encodedMessage = encoder.encode(message);
  const writeBuffer = accessHandle.write(encodedMessage, { at: readBuffer });

  // Persist changes to disk.
  accessHandle.flush();

  // Always close FileSystemSyncAccessHandle if done.
  accessHandle.close();
};

规范

规范
文件系统
# api-filesystemsyncaccesshandle-flush

浏览器兼容性

另见