Skip to content
目录

本文档是关于 fs-extra@v10.1.0 版本。

比如:下面别名

  • emptyDir -> emptydir 忽略大小写的别名
  • ensureFile -> createFile 语义上的别名
  • ensureDir -> mkdirs | mkdirp 将之前常用的名字替换为fs-extra规范的名字
  • ensureLink -> createLink
  • ensureSymlink -> createSymlink
  • readJson -> readJSON
  • writeJson -> writeJSON

相似功能:

  • outputFile & writeFile: output 版本更加的安全,会在文件不存在的情况下,创建该文件
  • outputJson & writeJson: output 版本更加的安全,会在文件不存在的情况下,创建该文件

同步版本和异步版本:

  • 同步版本一般就是在异步版本名字后添加 Sync 后缀。
  • 因为同步版本比较简单,本文档并没有列举出同步版本的文档,具体可以参考GitHub文档

下面对异步和同步的对应关系进行列举:

异步版本同步版本作用
copycopySync拷贝文件或目录
emptyDiremptyDirSync清空目录
ensureFileensureFileSync确保文件存在,不存在创建文件,存在则不做任何事
ensureDirensureDirSync确保文件夹存在,不存在则创建,别名 `mkdirs
ensureLinkensureLinkSync确保链接存在
ensureSymlinkensureSymlinkSync确保符号链接存在
movemoveSync移动文件或文件夹
outputFileoutputFileSync写入文件,类似 writeFile,它在文件不存在时创建文件
pathExistspathExistsSync测试给定路径是否存在
readJsonreadJsonSync读取JSON文件,解析为对象
removeremoveSync移除文件或文件夹,路径不存在不做任何事
outputJsonoutputJsonSync将对象写入到JSON文件中,类似 writeJson,json文件不存在时创建
writeJsonwriteJsonSync将对象写入到JSON文件中,注意和上面 outputJson 区别

2022年08月16日10:47:41