Walk
Simple node module to transverse files recursively.
Installation
npm install @fcostarodrigo/walk
Usage
import { walk } from "@fcostarodrigo/walk";
for await (const file of walk()) {
console.log(file);
}
Documentation
walk(root, lisFolders, walkFolder);
root: Optional folder to transverse. Defaults to ..
includeFolders: Optional flag to list folders. Defaults to false.
walkFolder: Optional callback to decide if a folder is going to be transversed.
The function is an async generator that yields the paths of the files recursively.
Changelog
License
MIT License
关于 @fcostarodrigo/walk 的常见问题
@fcostarodrigo/walk 是什么？
Transverse files recursively
如何安装 @fcostarodrigo/walk？
在项目目录运行 npm install @fcostarodrigo/walk，或使用 pnpm add / yarn add / bun add。
@fcostarodrigo/walk 支持 TypeScript 吗？
支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。
@fcostarodrigo/walk 支持 ESM 还是 CommonJS？
以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。
@fcostarodrigo/walk 可以商用吗？
@fcostarodrigo/walk 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。
@fcostarodrigo/walk 的下载量有多少？
根据 npm 官方下载统计，@fcostarodrigo/walk 在 2026/10/15 – 2026/11/13 这 30 天内被下载 3,998 次，日均约 133 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。
@fcostarodrigo/walk 还在维护吗？
最新版本 6.0.1 发布于 2024/05/22（2 年前）；至今共发布 7 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/08/03。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。