介绍
在前端开发中，我们经常需要遍历文件夹和读取文件。 readdir 是 Node.js 中一个强大的模块，可以帮助我们读取文件夹中的文件和子文件夹。但是，它存在一些限制，比如它只能读取单个子文件夹，无法读取所有子文件夹中的内容。这就是 @jsdevtools/readdir-enhanced 这个 npm 包的作用——它可以帮助我们解决这个问题。
安装
在使用 @jsdevtools/readdir-enhanced 之前，你需要先安装它。你可以在终端中运行以下命令：
npm install @jsdevtools/readdir-enhanced
使用
接下来，我们来学习如何使用 @jsdevtools/readdir-enhanced。
API
@jsdevtools/readdir-enhanced 暴露出一个 "readdir" 函数。这个函数接收两个参数：路径和选项。路径和选项的格式如下：
readdir(path, options);
path：要读取的文件夹路径options(可选)： 具有以下属性的对象：basePath(可选，字符串)：所有文件名将相对于此基本路径。默认值是os.homedir()。在传递此选项时，请确保它是决定性路径，这意味着路径在 OS 上存在，路径不是符号链接，并且不是相对路径。filter(可选，RegExp|Function|string)：返回一个布尔值的回调函数或 RegExp 匹配或者要排除——或者它们的字符串列表。默认为空。见下面的“过滤”deep(可选，布尔)：控制是否递归子目录。默认为false.sep(可选，字符串)：用于路径间隔符，默认为/。stats(可选，布尔)：如果为true，则在读取每个文件时获取 stat 对象。默认为false。fs(可选，对象)：用于读取文件系统。默认是“原始” Node.js 文件系统模块。concurrency(可选，数字)：在每个文件上操作的并发限制。默认为Number.MAX_SAFE_INTEGER，也就是没有限制。
示例
我们来看一个使用示例。假设我们有以下文件夹结构：
-- -------------------- ---- -------
-----
- ---------
- ---------
- -----------
- - ------------
- - ------------
- -----------
- --------------
- ---------------
- --------------
- ---------------我们要遍历 root 文件夹并读取所有文件。我们可以这样做：
const readdir = require('@jsdevtools/readdir-enhanced');
const files = readdir.sync('root', { deep: true });
// 输出结果
console.log(files);在这个例子中，我们使用了 readdir.sync() 函数，并传入了 root 文件夹路径和一个选项对象。选项对象中我们设置了 deep 属性为 true，意味着我们将递归读取所有子文件夹的内容。最终代码输出的结果如下：
-- -------------------- ---- ------- - ------------ ------------ ------------- -------------------------- -------------------------- ------------- --------------------------- ------------------------------------------- ----------------------------------------- -------------------------------------------------------- -
这里我们获得了包括文件名和文件夹名的完整路径列表。其中的 subfolder1 和 subfolder2 是文件夹名，它们在路径名与它们的子路径打通后显示了出来。
非递归遍历
如果你想非递归地遍历文件夹中的文件和子文件夹，你可以把 deep 设置为 false，比如：
const files = readdir.sync('root', { deep: false });过滤
如果想要过滤文件夹和文件，可以传递一个过滤器回调函数. 过滤器可以是一个正则表达式，函数，字符串，字符串列表，或混合数组。例如：
-- -------------------- ---- ------- -- --- --------- ----- ----- --------- - -------- ------- --------- - ------ ------------------------------ -- -- ------------------------ ----- --------------- - -------- ------- --------- - ------ --------- --- -------------- -- -- ---- ----- ----- - -------------------- - ------- ----------- ---------------- --- -- ---- -------------------
并发
如果你有很多文件和文件夹需要读取怎么办？你可以使用并发选项来加快读取的速度。concurrency 控制着从第一个文件开始读到最后一个文件结束所允许的并发。如果想添加一个限制（例如同时读取文件的文件数）可以设置此特殊选项。例如：
const files = readdir.sync('root', {
concurrency: 10
});这里我们限制了在任何时候只有 10 个文件可以同时读取。
异步读取
如果你需要异步读取文件，你可以使用 readdir.async() 函数，比如：
const readdir = require('@jsdevtools/readdir-enhanced');
readdir('root', { deep: true }).then(files => {
console.log(files);
});获取文件 stat 数据
在默认情况下，@jsdevtools/readdir-enhanced 不获取 stat 对象。如果你想获取 stat 对象，你可以给选项对象传递 stats 属性为 true，比如：
-- -------------------- ---- ------- ----- ------- - ---------------------------------------- ----- ----- - -------------------- - ----- ----- ------ ---- --- -- ----- ---- -- -------------------------- -- -------------
总结
@jsdevtools/readdir-enhanced 是一个强大且易于使用的 npm 包，可以帮助你遍历文件夹和读取文件。无论你正在处理的是小型还是庞大的项目，都可以使用此包优化读取效率，并扩展 Node.js 的文件浏览器功能。希望这篇文章能够帮助你掌握该包的使用方法。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedc798b5cbfe1ea06122a5