@fcostarodrigo/walk
DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/fcostarodrigo__walk package

5.0.1 • Public • Published

Walk

Codacy Badge Build Status codecov

Simple node module to transverse files recursively.

Installation

npm install @fcostarodrigo/walk

Usage

const walk = require("@fcostarodrigo/walk");

async function main() {
  for await (const file of walk()) {
    console.log(file);
  }
}

main();

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

Package Sidebar

Install

npm i @fcostarodrigo/walk

Weekly Downloads

64

Version

5.0.1

License

MIT

Unpacked Size

6.46 kB

Total Files

12

Last publish

Collaborators

  • fcostarodrigo