什么是 ndir？
ndir 是一个 Node.js 模块，可以递归遍历指定目录并返回包含文件和子目录的列表。它支持异步回调和 Promise 风格的 API，并且非常适合构建自动化工具、任务运行器以及静态站点生成器等项目。
安装 ndir
使用 npm 进行全局安装：
--- ------- -- ----
或者在项目中作为依赖项进行安装：
--- ------- ---- ------
使用 ndir
同步 API
要使用同步 API，请使用 ndir.readdirSync() 方法。以下是一个简单的示例，该示例列出了当前工作目录下的所有文件和目录：
----- ---- - ---------------- ----- ----- - ---------------------- -------------------
输出结果类似于：
- ------------ ------ ------- --------------- -------------- -
异步 API
要使用异步 API，请使用 ndir.readdir() 方法。以下是一个示例，该示例列出了指定目录下的所有文件和目录：
----- ---- - ---------------- ---------------------------------- ----- ------ -- - -- ----- ----- ---- ------------------- ---
请注意，ndir.readdir() 方法采用 Node.js 的惯用异步编程模型，它接受一个回调函数作为其最后一个参数。该回调函数应该具有两个参数：第一个参数是错误对象（如果有），第二个参数是包含文件和目录的数组。
过滤器
您可以使用 ndir.filter() 方法来过滤要返回的文件和目录。以下是一个示例，该示例只列出扩展名为 .txt 的文件：
----- ---- - ---------------- --------------------------------- ------ --------- -- - ------ -------------------------- -- ----- ------ -- - -- ----- ----- ---- ------------------- ---
请注意，ndir.filter() 方法采用与 ndir.readdir() 相同的惯用异步编程模型，并需要两个回调函数：过滤器函数和结果回调函数。过滤器函数应该接受两个参数：文件状态对象以及文件名。它应该返回一个布尔值，指示是否应将此文件包含在结果列表中。
配置
您可以使用 ndir.configure() 方法来配置 ndir 的默认行为。以下是一个示例，该示例将禁用隐藏文件（以.开头的文件）：
----- ---- - ----------------
----------------
------- ------ --------- -- -
------ ----------------------
-
---
---------------------------------- ----- ------ -- -
-- ----- ----- ----
-------------------
---总结
ndir 是一个非常有用的 npm 包，可以帮助您递归遍历目录并获取文件和目录列表。它支持同步和异步 API，还支持过滤器和配置选项。如果您正在构建自动化工具、任务运行器或静态站点生成器等项目，那么 ndir 可能会成为您的好帮手。
希望本文对于您使用 ndir 有所帮助！
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/45102