简介
readdir-r 是一款 npm 包，它提供了一个递归地读取目录下所有文件的功能。相较于 Node.js 自带的 readdir，readdir-r 可以更简单方便地读取嵌套的子目录中的文件。本文将详细介绍如何安装和使用 readdir-r。
安装
在命令行中运行以下命令即可安装 readdir-r：
npm install readdir-r --save
使用方法
基本用法
我们先来看一下文件结构：
. ├── index.js └── test ├── 1.txt ├── 2.txt └── subdir ├── 3.txt └── 4.txt
我们想要读取 test 目录下的所有文件，包括子目录中的文件，可以使用以下代码：
-- -------------------- ---- ------- ----- ------- - --------------------- ----------------- ----- ------ -- - -- ----- - ------------------- ------- - ------------------- ---展开代码
其中，readdir 函数接受两个参数：目录的路径和回调函数。回调函数的第一个参数是错误信息（如果有的话），第二个参数是读取到的文件列表。在上述例子中，我们使用相对路径 './test' 来指定目录路径。
运行该代码，控制台将打印如下结果：
[ '1.txt', '2.txt', 'subdir/3.txt', 'subdir/4.txt' ]
从结果中可以看出，readdir-r 递归地读取了 test 目录下的所有文件，包括子目录 subdir 中的文件。与 Node.js 自带的 readdir 函数不同，readdir-r 不仅返回了文件名，还包括子目录的路径。
过滤文件
有时候我们希望过滤掉一些无用的文件，可以使用 filterFn 参数。例如，我们想只读取 test 目录中的 .txt 文件，可以使用以下代码：
-- -------------------- ---- ------- ----- ------- - --------------------- ----------------- - --------- ---------- --------- -- - ------ ------------------------ - -- ----- ------ -- - -- ----- - ------------------- ------- - ------------------- ---展开代码
在 filterFn 参数中，我们传入了一个函数，该函数接受两个参数：文件名和文件路径。该函数需要返回一个布尔值，如果返回 true，则保留该文件，否则过滤掉该文件。
在上述例子中，我们使用正则表达式来判断文件是否以 .txt 结尾，如果是则保留该文件。运行该代码，控制台将打印如下结果：
[ '1.txt', '2.txt', 'subdir/3.txt', 'subdir/4.txt' ]
只有以 .txt 结尾的文件被返回，其他类型的文件被过滤掉了。
排序文件
有时候我们希望按照某种规则排序文件，可以使用 sortFn 参数。例如，我们想按文件名长度从短到长排序文件，可以使用以下代码：
-- -------------------- ---- ------- ----- ------- - --------------------- ----------------- - ------- --- -- -- - ------ -------- - --------- - -- ----- ------ -- - -- ----- - ------------------- ------- - ------------------- ---展开代码
在 sortFn 参数中，我们传入了一个函数，该函数接受两个参数：文件名。该函数需要返回一个数字，用于排序文件。在上述例子中，我们按照文件名长度从短到长排序文件。运行该代码，控制台将打印如下结果：
[ '1.txt', '2.txt', 'subdir/3.txt', 'subdir/4.txt' ]
文件名长度越短的文件越靠前。
结语
readdir-r 是一款方便实用的 npm 包，可用于递归地读取目录下的所有文件。本文详细介绍了如何安装和使用 readdir-r，以及过滤和排序文件。希望本文能够对您理解和使用 readdir-r 有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/75071
