Skip to content

Simple node module to transverse files recursively.

License

Notifications You must be signed in to change notification settings

fcostarodrigo/walk

Repository files navigation

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