npm 包 @nodelib/fs.scandir 使用教程

什么是 @nodelib/fs.scandir?

@nodelib/fs.scandir 是一个 Node.js 的文件系统扫描器，它可以帮助你快速的扫描一个目录中的文件和子目录，并返回一个包含这些文件和子目录的数组。

为什么要使用 @nodelib/fs.scandir?

在 Node.js 中，通过 fs 模块读取目录中的文件和子目录需要编写相对复杂的代码。而 @nodelib/fs.scandir 可以帮助你轻松快速的获取目录中的文件和子目录，同时还能支持各种文件过滤，方便你快速获取所需的文件。

@nodelib/fs.scandir 的使用教程

1. 安装 @nodelib/fs.scandir

使用 npm 安装 @nodelib/fs.scandir：

npm install @nodelib/fs.scandir

1. 扫描目录

使用 scanDirectorySync 函数扫描目录，该函数支持一个参数，传入要扫描的目录路径。例如：

const fsScandir = require('@nodelib/fs.scandir');

const filesArray = fsScandir.scanDirectorySync('./testPath');

1. 过滤文件

scanDirectorySync 函数还支持传递一个过滤器函数，过滤掉不需要的文件。例如：

const fsScandir = require('@nodelib/fs.scandir');
const {isFile} = require('@nodelib/fs.stat');

const onlyFiles = item => isFile(item.path);

const filesArray = fsScandir.scanDirectorySync('./testPath', {filter: onlyFiles});

在上面的例子中，我们使用了 @nodelib/fs.stat 中的 isFile 函数来判断当前项是否为文件，如果是则返回 true，否则返回 false。

1. 只扫描指定目录深度的文件

scanDirectorySync 函数还支持一个深度参数，用来只扫描指定深度的目录。例如：

const fsScandir = require('@nodelib/fs.scandir');

const filesArray = fsScandir.scanDirectorySync('./testPath', {deep: 1});

在上面的例子中，我们只扫描了 testPath 目录的一级子目录下的所有文件和子目录。

示例代码

下面是一个完整的 @nodelib/fs.scandir 示例代码：

const fsScandir = require('@nodelib/fs.scandir');
const {isFile} = require('@nodelib/fs.stat');

const onlyFiles = item => isFile(item.path);

const filesArray = fsScandir.scanDirectorySync('./testPath', {deep: 1, filter: onlyFiles});

console.log(filesArray);

总结

通过本文的学习，你现在对 @nodelib/fs.scandir 的使用已经有了比较深入的了解，同时你也可以尝试使用这个 npm 包来获取你需要的文件，加快 Node.js 目录扫描的速度。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5f08005d403f2923b035bfad