简介
readdirp 是一个 Node.js 的 npm 包，用于递归读取指定目录下的所有文件和子目录。相比 Node.js 原生的 fs.readdir 方法，readdirp 提供了更为强大和灵活的功能，例如支持过滤指定类型的文件、自定义排序等。
在前端开发中，我们通常会需要遍历某个目录下的所有文件，如从某个目录加载图片资源或者读取某个目录下的 JSON 配置文件等。使用 readdirp 能够方便快捷地完成这些任务。
安装
使用 npm 安装：
npm install readdirp
使用方法
基本用法
-- -------------------- ---- -------
----- -------- - --------------------
-----------------------
----------- -------- ------- -
------------------------
--
---------- -------- -- -
--------------------
---以上代码示例中，readdirp 函数接收两个参数，第一个参数是要遍历的目录路径，第二个参数是可选的配置项。
readdirp 函数返回一个可读流（Readable Stream），我们可以使用 Node.js 中原生的事件机制来监听读取到数据和流结束的事件。
当读取到目录下的一个文件时，data 事件会被触发，回调函数的参数 entry 为一个包含文件信息的对象，其中最常见的属性有：
entry.path：相对于根目录的路径entry.fullPath：绝对路径entry.stats：文件状态对象，包括isFile()、isDirectory()等方法
当读取完所有文件时，end 事件会被触发，我们可以在回调函数中做一些清理工作。
配置选项
除了基本用法以外，我们还可以通过第二个参数来配置 readdirp 的行为。以下是一些常用的配置选项：
fileFilter：一个正则表达式或者回调函数，用于过滤读取到的文件。directoryFilter：同上，但是只针对目录。depth：指定遍历的深度，默认为无限制。entryType：指定返回的条目类型，可以是'files'、'directories'或'both'，默认为'files'。sort：自定义排序函数。
-- -------------------- ---- -------
----- -------- - --------------------
-- ---- -- --
----- ------------- - -------- ------- -
------ ---------------------------
--
----------------------- - ----------- ------------- --
----------- -------- ------- -
------------------------
--
---------- -------- -- -
--------------------
---以上代码示例中，我们通过传入一个回调函数来过滤所有 .js 文件。
错误处理
在使用 readdirp 的过程中，可能会出现一些错误，例如指定的目录不存在、权限不足等。我们可以通过监听可读流的 error 事件来捕获这些错误：
-- -------------------- ---- -------
----- -------- - --------------------
-------------------------------
------------ -------- ----- -
-------------------
--
---------- -------- -- -
--------------------
---总结
readdirp 是一个非常实用的 npm 包，在前端开发中常常用于遍历某个目录下的所有文件和子目录。通过本文的介绍，我们了解了 readdirp 的基本用法、配置选项以及错误处理方法，希望能够对大家的工作有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/42925