FileSystemDirectoryHandle: getFileHandle() 方法

语法

getFileHandle(name)
getFileHandle(name, options)

参数

name

一个字符串，表示您想要获取的文件的 FileSystemHandle.name。

options 可选

具有以下属性的对象：

create 可选

一个 Boolean 类型的值。默认为 false。当设置为 true 时，如果文件不存在，则会创建一个具有指定名称的文件并返回。

返回值

一个 Promise，它会解析为一个 FileSystemFileHandle 对象。

异常

NotAllowedError DOMException

如果句柄的 PermissionStatus.state 对于 readwrite 模式（当 create 选项设置为 true 时）或 read 模式（当 create 选项设置为 false 时）不是 'granted'，则会抛出此错误。

TypeError

如果指定的名称不是有效的字符串，或者包含会干扰本地文件系统的字符，则会抛出此错误。

TypeMismatchError DOMException

如果命名的条目是一个目录而不是文件，则会抛出此错误。

NotFoundError DOMException

如果当前条目未找到，或者文件不存在且 create 选项设置为 false，则会抛出此错误。

示例

以下示例返回指定名称的文件句柄；如果文件不存在，则会创建该文件。

const fileName = "fileToGetName";

// assuming we have a directory handle: 'currentDirHandle'
const fileHandle = await currentDirHandle.getFileHandle(fileName, {
  create: true,
});

规范

浏览器兼容性

另见

• File System API
• 文件系统访问 API：简化对本地文件的访问