FileSystemSyncAccessHandle：getSize() 方法

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.

安全上下文: 此项功能仅在一些支持的浏览器的安全上下文（HTTPS）中可用。

备注： 此特性仅在专用 Web Worker 中可用。

FileSystemSyncAccessHandle 接口的 getSize() 方法用于返回与句柄相关联文件的字节大小。

备注： 在规范早期版本中，close()、flush()、getSize() 和 truncate() 被错误地规定为异步方法。某些浏览器的旧版本是依照异步方式来实现这些方法的，不过，现今所有支持这些方法的浏览器都将它们实现为同步方法。

语法

js
getSize()

参数

无。

返回值

一个表示文件字节大小的数字。

异常

InvalidStateError DOMException

如果相关的访问句柄已经被关闭，抛出此异常。

示例

下面的异步事件处理函数包含在一个 Web Worker 中。当收到来自主线程的消息时，它将执行：

  • 创建一个同步文件访问句柄。
  • 获取文件的大小然后创建一个 ArrayBuffer 来容纳其内容。
  • 将文件内容读取到缓冲区。
  • 将收到的消息编码然后写入到文件的末尾。
  • 将更改保存到磁盘然后关闭访问句柄。
js
onmessage = async (e) => {
  // 接收从主线程发来的消息
  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();
};

规范

Specification
File System Standard
# api-filesystemsyncaccesshandle-getsize

浏览器兼容性

BCD tables only load in the browser

参见