rrdir

rrdir

The fastest recursive readdir in town

Recursively crawls a directory to obtain paths and information on directory/symlink one each entry. Takes advantage of uv_fs_scandir support since Node.js 10.10, which may improve performance by up to 200% over previous efforts. Some non-scientific benchmark results comparing against the popular node-walkdir module:

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

Installation

npm i rrdir

Examples

const rrdir = require('rrdir');

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

// sync
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. rrdir returns a Promise while rrdir.sync synchronously returns entries with is an array of entry. Both functions will throw/reject on unexpected errors, but can optionally ignore errors encountered on individual files.

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.
• entry.symlink boolean: Boolean indicating whether the entry is a symbolic link.

Options

• options.strict boolean: Whether to throw errors when reading fails. Default: false.
• options.encoding string: The encoding to use in the entry's path. Default: 'utf8'.

© silverwind, distributed under BSD licence