rrdir

rrdir recursively reads a directory and returns entries within via an async iterator or async/sync as Array. It can typically iterate millions of files in a matter of seconds. Memory usage is O(1) for the async iterator and O(n) for the Array variants.

This module is able to read any path including ones that contain invalid UTF-8 sequences.

Benchmark	rrdir	fdir
async	56ms	56ms
sync	150ms	173ms
async + glob	64ms	62ms
sync + glob	171ms	194ms
async + exclude	49ms	36ms
sync + exclude	118ms	112ms
async iterator	78ms	—

Results for 122K entries (111K files, 11K dirs), Node.js on macOS. rrdir returns richer entries (path + directory + symlink) while fdir returns only paths. fdir uses picomatch for glob matching, rrdir has a built-in glob matcher. Run with make bench.

Usage

npm i rrdir

import {rrdir, rrdirAsync, rrdirSync} from "rrdir";

for await (const entry of rrdir("dir")) {
  // => {path: 'dir/file', directory: false, symlink: false}
}

const entries = await rrdirAsync("dir");
// => [{path: 'dir/file', directory: false, symlink: false}]

const entries = rrdirSync("dir");
// => [{path: 'dir/file', directory: false, symlink: false}]

API

rrdir(dir, [options])

rrdirAsync(dir, [options])

rrdirSync(dir, [options])

rrdir is an async iterator which yields entry. rrdirAsync and rrdirSync return an Array of entry.

dir String | Uint8Array

The directory to read, either absolute or relative. Pass a Uint8Array to switch the module into Uint8Array mode which is required to be able to read every file, like for example files with names that are invalid UTF-8 sequences.

options Object

• stats boolean: Whether to include entry.stats. Will reduce performance. Default: false.
• followSymlinks boolean: Whether to follow symlinks for both recursion and stat calls. Default: false.
• exclude Array: Path globs to exclude, e.g. ["**.js"]. Default: undefined.
• include Array: Path globs to include, e.g. ["**.map"]. Default: undefined.
• strict boolean: Whether to throw immediately when reading an entry fails. Default: false.
• insensitive boolean: Whether include and exclude match case-insensitively. Default: false.

entry Object

• path string | Uint8Array: The path to the entry, will be relative if dir is given relative. If dir is a Uint8Array, this will be too. Always present.
• directory boolean: Boolean indicating whether the entry is a directory. undefined on error.
• symlink boolean: Boolean indicating whether the entry is a symbolic link. undefined on error.
• stats Object: A fs.stats object, present when options.stats is set. undefined on error.
• err Error: Any error encountered while reading this entry. undefined on success.

© silverwind, distributed under BSD licence