FileSystemSyncAccessHandle：flush() 方法

基线 2023

新可用

自 2023 年 3 月起，此功能可在最新的设备和浏览器版本中使用。此功能可能在较旧的设备或浏览器中无法使用。

安全上下文：此功能仅在安全上下文（HTTPS）中可用，在某些或所有支持的浏览器中可用。

注意：此功能仅在专用 Web 工作线程中可用。

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

请记住，只有在需要在特定时间将更改提交到磁盘时才需要调用此方法，否则可以将此操作留给底层操作系统在适当的时候处理，在大多数情况下这应该没问题。

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

语法

js
flush()

参数

无。

返回值

无 (undefined)。

异常

InvalidStateError DOMException

如果关联的访问句柄已关闭，则抛出此异常。

示例

以下异步事件处理程序函数包含在 Web 工作线程中。在从主线程接收消息时，它

  • 创建一个同步文件访问句柄。
  • 获取文件的大小并创建一个 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

浏览器兼容性

BCD 表格仅在启用了 JavaScript 的浏览器中加载。

另请参阅