前言
在前端开发中，我们常常需要读取一个目录下的所有文件并进行操作，比如说读取一系列图片文件进行缩放等等。整理目录下的文件名、路径等等也是常见需求。不过在 node.js 中，读取一个目录下的所有文件不是一件很方便的事情，需要我们手动实现递归遍历等等，这时候就出现了很多帮助我们快速实现这些功能的 NPM 包，如 dirreader。
dirreader 是一个非常简单好用的 NPM 包，可以方便地遍历目录下的所有文件并返回给我们，大大减小了我们的编写时间。
安装
dirreader 可以通过 NPM 进行安装：
npm install dirreader --save
使用方法
API
dirreader 提供了多个方法用于读取目录等操作，具体 API 如下：
readDirSync(path: string): string[]同步读取一个目录下的所有文件路径readDir(path: string): Promise<string[]>异步读取一个目录下的所有文件路径readDirFn(options: {path: string, transform: (item: DirItem) => {}}): {}同步读取一个目录下的所有文件并将结果按照 transform 处理后组成一个 objectreadDirFnAsync(options: {path: string, transform: (item: DirItem) => {}}): {}异步读取一个目录下的所有文件并将结果按照 transform 处理后组成一个 object
示例
以下是一个使用 dirreader 读取指定目录下所有文件的示例：
const { readDir } = require('dirreader');
const path = './images';
readDir(path)
.then(files => console.log(files))
.catch(err => console.error(err));以上代码使用 readDir 方法异步读取指定目录并返回所有文件路径。如果路径 ./images 中存在文件夹，则该文件夹下的所有文件也会被返回。
我们还可以使用 readDirSync 方法同步读取目录下的所有文件：
const { readDirSync } = require('dirreader');
const path = './images';
const files = readDirSync(path);
console.log(files);这样我们就可以得到所有文件的路径。
最后，我们演示一下 readDirFn 方法的使用：
-- -------------------- ---- ------- ----- - --------- - - --------------------- ----- ---- - ----------- ----- ----- - ----------- ----- ---------- -- ---- -- -- -- ------- ---------- --- --- -------------------
以上示例中，我们使用 readDirFn 方法同步读取指定目录下的所有文件，然后对文件名进行了改造，生成了一个可以直接转化成 object 的 object。
结语
dirreader 简单好用，可以方便地读取目录下的所有文件，让前端开发变得更加便利。之前我在项目中也使用过 dirreader，感觉非常不错，强烈推荐给大家。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/75241