@aboviq/readdir-recursive 中文文档教程

Question

@aboviq/readdir-recursive

可自定义的异步递归 fs.readdir，没有依赖项和合理的默认值

Why?

• No dependencies / Small
• Asynchronous, i.e. returns a promise (uses async/await under the hood)
• Provides a syncronous version as well
• Sane defaults, i.e. does not recurse into node_modules by default
• Fully customizable, with options to decide in which folders to recurse into and what files and information to include in the results, with full access to each file's Stats information

Installation

安装 @aboviq/ readdir-recursive 使用 npm：

npm install @aboviq/readdir-recursive

Usage

Module usage

const readdirRecursive = require('@aboviq/readdir-recursive');

const files = await readdirRecursive('a/path');
/*
[
  "/full-path/a/path/filename.ext",
  "/full-path/a/path/nested/folders/another.ext",
  ...
]
*/

const files = readdirRecursive.sync('a/path');
/*
[
  "/full-path/a/path/filename.ext",
  "/full-path/a/path/nested/folders/another.ext",
  ...
]
*/

API

readdirRecursive(dir, options)

Name	Type	Description
dir	String	The folder to read files recursively in, either relative to cwd or an absolute path
options	Object	Options for filtering, recursion and transformation

返回：Promise，所有找到的文件根据转换 <

readdirRecursive.sync(dir, options)

Name	Type	Description
dir	String	The folder to read files recursively in, either relative to cwd or an absolute path
options	Object	Options for filtering, recursion and transformation

返回：数组，找到所有根据transformer转换后未过滤掉的文件

Options

strong>注意：所有函数选项都可以使用readdirRecursive，但不是同步版本。

options.filter

类型：函数
签名：filter :: Object -> 布尔值
默认值：<代码>() => true

filter 选项用于决定文件是否应包含在生成的文件数组中。 如果过滤器函数返回真值，则包含一个文件。

传递给 filter 函数的 Object 具有以下属性：

Name	Type	Description
file	String	The file name, e.g. "file.txt"
path	String	The full path to the file, e.g. "/your/folder/sub-folder/file.txt"
stats	Stats	A stats object providing information about the file

options.transform

类型：Function
签名：transform :: Object -> 字符串
默认值：返回每个文件的完整路径的函数

transform 选项用于将文件信息转换为有用的信息。 每个通过过滤器函数的文件在被包含在结果数组中之前都会被转换。

传递给 transform 函数的 Object 具有以下属性：

Name	Type	Description
file	String	The file name, e.g. "file.txt"
path	String	The full path to the file, e.g. "/your/folder/sub-folder/file.txt"
stats	Stats	A stats object providing information about the file

options.recurse

类型：Function
签名：recurse :: Object -> 布尔值
默认值：不会递归的函数 node_modules

recurse 选项用于决定文件夹是否应该递归。 如果递归函数返回真值，则文件夹被递归。

传递给 recurse 函数的 Object 具有以下属性：

Name	Type	Description
dir	String	The folder name, e.g. "src"
path	String	The full path to the folder, e.g. "/your/folder/sub-folder"
stats	Stats	A stats object providing information about the folder

Contributing

请参阅贡献指南 和我们的 行为准则。

License

麻省理工学院 © Aboviq AB