📜  NodeJS fs-extra emptyDir()函数(1)

📅  最后修改于: 2023-12-03 15:33:11.173000             🧑  作者: Mango

NodeJS fs-extra emptyDir()函数介绍

emptyDir()函数是 npm fs-extra 模块提供的一个用于清空文件夹的API。该函数会删除指定文件夹下的所有文件和子文件夹,但不会删除该文件夹本身。它的用法如下:

const fs = require('fs-extra')

fs.emptyDir('/path/to/folder')
  .then(() => {
    console.log('success!')
  })
  .catch(err => {
    console.error(err)
  })

在上面的示例代码中,我们调用 emptyDir() 函数来清空指定路径下的文件夹。如果清空成功,则输出 success!;否则输出错误信息。

需要注意的是,emptyDir() 函数返回一个 Promise 对象,我们可以使用 .then().catch() 方法来分别处理成功和失败的情况。

参数说明

emptyDir() 函数只接受一个参数,即要清空的文件夹路径。

async emptyDir(path: string): Promise<void>
使用场景

emptyDir() 函数常用于需要清空文件夹的场景,比如:

  • 在构建项目时,清空输出目录,以便重新生成最新的文件。
  • 在测试过程中,清空测试数据生成的临时文件夹。
  • 在下载文件的场景中,先清空下载目录再开始下载。
注意事项
  • 仅清空指定文件夹下的文件和子文件夹,不会删除该文件夹本身。如果需要删除该文件夹,请使用 fs.rmdir() 函数。
  • emptyDir() 函数不会检查要清空的文件夹是否存在,如果该文件夹不存在,则会抛出一个异常。
  • emptyDir() 函数只会删除文件夹下的文件和子文件夹,但不会删除软链接、空目录和隐藏文件,如果需要删除这些文件,请使用其他相应的函数。

以上是对 NodeJS fs-extra emptyDir()函数 的介绍。使用该函数可以非常方便地清空文件夹,使代码更加健壮和可维护。