@elricb/readdir-recursive

@elricb/readdir-recursive

Built as a wrapper for node readdir function.

Recursively steps through directory and all sub-directories, returning each item into callback.

Requirements

• node - recommended lts version >= 12

Install

$ npm install --save @elricb/readdir-recursive

Usage

Warning: This does not have any max-depth or max-file checking. If you need protection from large directories use Asynchronous, throw error inside the callback, and processing will halt.

Asynchronous

import {readdirRecursive} from "@elricb/readdir-recursive";

readdirRecursive(__dirname, function(directory, dirent) {
  if (dirent.isFile()) {
    console.log(directory);
  }
})
  .then(function() {
    console.log("Done.");
  })
  .catch(function(error) {
    console.error(error);
  });

Synchronous

import {readdirRecursiveSync} from "@elricb/readdir-recursive";

readdirRecursiveSync(__dirname, function(directory, dirent) {
  if (dirent.isDirectory()) {
    console.log(directory);
  }
});

console.log("Done.");

Documentation

Release Notes

View commit tag for release notes.

• release list

API

See ./docs/index.html.