rrdir

rrdir

The fastest recursive readdir in town

Recursively crawls a directory to obtain paths and information on directory/symlink on each entry. Takes advantage of uv_fs_scandir in Node.js 10.10 or higher, which increases performance significantly.

Comparison against the walkdir module crawling the Node.js repository on a NVMe SSD:

Test	Engine	OS	Runtime
rrdir sync	Node.js 10.10.0	Linux 4.18.4	0.289s
rrdir async	Node.js 10.10.0	Linux 4.18.4	0.400s
walkdir sync	Node.js 10.10.0	Linux 4.18.4	0.423s
walkdir async	Node.js 10.10.0	Linux 4.18.4	1.557s
rrdir sync	Node.js 8.11.4	Linux 4.18.4	0.383s
walkdir sync	Node.js 8.11.4	Linux 4.18.4	0.416s
rrdir async	Node.js 8.11.4	Linux 4.18.4	1.148s
walkdir async	Node.js 8.11.4	Linux 4.18.4	1.813s

Installation

npm i rrdir

Examples

const rrdir = require('rrdir');
const entries = await rrdir('../dir'); // => [{path: '../dir/file1', directory: false, symlink: true}]
const entries = rrdir.sync('../dir'); // => [{path: '../dir/file1', directory: false, symlink: true}]

API

rrdir(dir, [options])

rrdir.sync(dir, [options])

Recursively searches a directory for entries contained within. Both functions will reject or throw on unexpected errors, but can optionally ignore errors encountered on individual files. Returns an array of entry.

entry

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

options

• options.stats boolean: Include entry.stats. Will reduce performance. Default: false.
• options.exclude Array: Path globs to exclude from the result. Default: [].
• options.strict boolean: Whether to throw immediately when reading an entry fails. Default: false.
• options.encoding string: The encoding to use on entry.path. Default: 'utf8'.
• options.minimatch Object: minimatch options. Default: {matchBase: true, dot: true, nocomment: true}.

© silverwind, distributed under BSD licence