access | (params: AccessParams) => Promise<void> | 是 | 判断文件或目录是否存在(异步)。存在时 Promise 兑现,不存在时 Promise 拒绝。 |
accessSync | (params: AccessParams) => void | 是 | 判断文件或目录是否存在(同步)。不存在时抛出异常。 |
appendFile | (params: AppendFileParams) => Promise<void> | 是 | 在文件末尾追加内容(异步)。文件不存在则创建,不会覆盖已有内容。 |
appendFileSync | (params: AppendFileParams) => void | 是 | 在文件末尾追加内容(同步)。文件不存在则创建,不会覆盖已有内容。 |
copyFile | (params: CopyFileParams) => Promise<void> | 是 | 复制文件(异步)。仅支持文件,目标已存在同名文件时覆盖。 |
copyFileSync | (params: CopyFileParams) => void | 是 | 复制文件(同步)。仅支持文件,目标已存在同名文件时覆盖。 |
getFileInfo | (params: GetFileInfoParams) => Promise<GetFileInfoResult> | 是 | 获取文件信息(异步);返回 GetFileInfoResult,含字节大小和可选的摘要。 |
getSavedFileList | () => Promise<GetSavedFileListResult> | 是 | 获取已保存的本地文件列表(异步);返回 GetSavedFileListResult,每项含路径、字节大小和毫秒级保存时间。 |
mkdir | (params: MkdirParams) => Promise<void> | 是 | 创建目录(异步)。recursive 为 true 时一并创建缺失的上级目录。 |
mkdirSync | (params: MkdirParams) => void | 是 | 创建目录(同步)。recursive 为 true 时一并创建缺失的上级目录。 |
readdir | (params: ReaddirParams) => Promise<ReaddirResult> | 是 | 读取目录内容(异步);返回 ReaddirResult,files 为目录下的文件与子目录名称(非完整路径,非递归)。 |
readdirSync | (params: ReaddirParams) => ReaddirResult | 是 | 读取目录内容(同步);返回 ReaddirResult,files 为目录下的文件与子目录名称(非完整路径,非递归)。 |
readFile | (params: ReadFileParams) => Promise<ReadFileResult> | 是 | 读取文件内容(异步);返回 ReadFileResult,其中 data 按 encoding 为 UTF-8 或 Base64 字符串。 |
readFileSync | (params: ReadFileParams) => ReadFileResult | 是 | 读取文件内容(同步);返回 ReadFileResult,其中 data 按 encoding 为 UTF-8 或 Base64 字符串。 |
removeSavedFile | (params: RemoveSavedFileParams) => Promise<void> | 是 | 删除通过 saveFile 保存的本地文件(异步)。 |
rename | (params: RenameParams) => Promise<void> | 是 | 重命名或移动文件(异步)。目标已存在同名文件时覆盖。 |
renameSync | (params: RenameParams) => void | 是 | 重命名或移动文件(同步)。目标已存在同名文件时覆盖。 |
rmdir | (params: RmdirParams) => Promise<void> | 是 | 删除目录(异步)。recursive 为 false 时仅能删除空目录,为 true 时递归删除全部内容。 |
rmdirSync | (params: RmdirParams) => void | 是 | 删除目录(同步)。recursive 为 false 时仅能删除空目录,为 true 时递归删除全部内容。 |
saveFile | (params: SaveFileParams) => Promise<SaveFileResult> | 是 | 将临时文件保存到本地持久化存储(异步);返回 SaveFileResult,含实际保存路径。 |
saveFileSync | (params: SaveFileParams) => SaveFileResult | 是 | 将临时文件保存到本地持久化存储(同步);返回 SaveFileResult,含实际保存路径。 |
stat | (params: StatParams) => Promise<StatResult> | 是 | 获取文件或目录状态(异步);返回 StatResult,含字节大小、毫秒级修改时间和是否为目录。 |
statSync | (params: StatParams) => StatResult | 是 | 获取文件或目录状态(同步);返回 StatResult,含字节大小、毫秒级修改时间和是否为目录。 |
truncate | (params: TruncateParams) => Promise<void> | 是 | 截断文件到指定长度(异步)。短于原长度时截断,长于原长度时以 \0 填充。 |
truncateSync | (params: TruncateParams) => void | 是 | 截断文件到指定长度(同步)。短于原长度时截断,长于原长度时以 \0 填充。 |
unlink | (params: UnlinkParams) => Promise<void> | 是 | 删除文件(异步)。只能删除文件,删除目录请使用 rmdir。 |
unlinkSync | (params: UnlinkParams) => void | 是 | 删除文件(同步)。只能删除文件,删除目录请使用 rmdir。 |
unzip | (params: UnzipParams) => Promise<void> | 是 | 解压 zip 文件到指定目录(异步)。目标目录须已存在。 |
writeFile | (params: WriteFileParams) => Promise<void> | 是 | 写入文件内容(异步)。文件和父目录不存在则创建,文件已存在则覆盖。 |
writeFileSync | (params: WriteFileParams) => void | 是 | 写入文件内容(同步)。文件和父目录不存在则创建,文件已存在则覆盖。 |