FileSystemFileHandle: getFile() 方法

基线 2023

新可用

2023 年 3 月起,此功能适用于最新的设备和浏览器版本。此功能可能不适用于较旧的设备或浏览器。

安全上下文:此功能仅在 安全上下文(HTTPS)中,以及一些或全部 支持浏览器 中可用。

注意:此功能在 Web 工作线程 中可用。

getFile() 方法是 FileSystemFileHandle 接口的方法,它返回一个 Promise,该 Promise 解析为一个 File 对象,表示该句柄所表示的条目的磁盘状态。

如果磁盘上的文件在调用此方法后发生更改或被删除,则返回的 File 对象可能无法再读取。

语法

js
getFile()

参数

无。

返回值

一个 Promise,它解析为一个 File 对象。

异常

NotAllowedError DOMException

如果 PermissionStatus.state 不是 granted(已授予)的“读取”模式,则抛出此异常。

NotFoundError DOMException

如果找不到当前条目,则抛出此异常。

示例

以下异步函数将呈现一个文件选择器,并且在选择文件后,将使用 getFile() 方法检索内容。

js
async function getTheFile() {
  // open file picker
  [fileHandle] = await window.showOpenFilePicker(pickerOpts);

  // get file contents
  const fileData = await fileHandle.getFile();
}

规范

规范
文件系统标准
# api-filesystemfilehandle-getfile

浏览器兼容性

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

另请参阅