fs-readdir-recursive

What is fs-readdir-recursive?

The fs-readdir-recursive npm package is a utility for reading directories recursively. It allows you to list all files within a directory and its subdirectories, making it useful for tasks that require directory traversal.

What are fs-readdir-recursive's main functionalities?

Read all files in a directory recursively

This feature allows you to read all files in a specified directory and its subdirectories. The code sample demonstrates how to use the package to list all files within 'path/to/directory'.

const read = require('fs-readdir-recursive');
const files = read('path/to/directory');
console.log(files);

Filter files based on a condition

This feature allows you to filter the files based on a condition. The code sample demonstrates how to list only JavaScript files within 'path/to/directory' and its subdirectories.

const read = require('fs-readdir-recursive');
const files = read('path/to/directory', (name) => name.endsWith('.js'));
console.log(files);

Other packages similar to fs-readdir-recursive

recursive-readdir

The recursive-readdir package provides similar functionality to fs-readdir-recursive, allowing you to read directories recursively. It also supports filtering files based on conditions and excluding specific files or directories.

klaw

The klaw package is another alternative for recursive directory traversal. It provides a stream-based API for reading directories and supports filtering and excluding files or directories. It is more flexible and powerful compared to fs-readdir-recursive.

readdirp

The readdirp package offers recursive directory reading with additional features like filtering, streaming, and handling large directories efficiently. It is more feature-rich and performant compared to fs-readdir-recursive.

README

fs.readdirSyncRecursive

Read a directory recursively.

Install

npm install fs-readdir-recursive

Example

var read = require('fs-readdir-recursive')
read(__dirname) === [
  'test/test.js',
  'index.js',
  'LICENSE',
  'package.json',
  'README.md'
]

API

read(root [, filter])

root is the directory you wish to scan. filter is an optional filter for the files with three params(name, index, dir). By default, filter is:

function (name) {
  return name[0] !== '.'
}

Which basically just ignores . files.