Tiny Readdir

A simple promisified recursive readdir function.

Install

1npm install --save tiny-readdir

Usage

1import readdir from 'tiny-readdir';
2
3const aborter = new AbortController ();
4
5const result = await readdir ( '/foo/bar', {
6  depth: 20, // Maximum depth to look at
7  limit: 1_000_000, // Maximum number of files explored, useful as a stop gap in some edge cases
8  followSymlinks: true, // Whether to follow symlinks or not
9  ignore: targetPath => /node_modules/.test ( targetPath ), // Function that if returns true will ignore this particular file or a directory and its descendants
10  signal: aborter.signal, // Optional abort signal, useful for aborting potentially expensive operations
11  onDirents: dirents => console.log ( dirents ) // Optional callback that will be called as soon as new dirents are available, useful for example for discovering ".gitignore" files while searching
12});
13
14result.directories; // => Array of absolute paths pointing to directories
15result.files; // => Array of absolute paths pointing to files
16result.symlinks; // => Array of absolute paths pointing to symlinks
17
18result.directoriesNames; // => Set of directories names found
19result.filesNames; // => Set of files name found
20result.symlinksNames; // => Set of symlinks names found
21
22result.directoriesNamesToPaths; // => Record of directories names found to their paths
23result.filesNamesToPaths; // => Record of files names found to their paths
24result.symlinksNamesToPaths; // => Record of symlinks names found to their paths
25
26setTimeout ( () => aborter.abort (), 10_000 ); // Aborting if it's going to take longer than 10s

License

MIT © Fabio Spampinato