Tiny Readdir Glob

A simple promisified recursive readdir function, with support for globs.

Install

1npm install --save tiny-readdir-glob

Usage

1import readdir from 'tiny-readdir-glob';
2
3// Let's recursively read into a directory using a glob
4
5const aborter = new AbortController ();
6const result = await readdir ( ['src/**/*.js'], {
7  depth: 20, // Maximum depth to look at
8  limit: 1_000_000, // Maximum number of files explored, useful as a stop gap in some edge cases
9  followSymlinks: true, // Whether to follow symlinks or not
10  ignore: ['**/.git', '**/node_modules'], // Globs, or raw function, that if returns true will ignore this particular file or a directory and its descendants
11  signal: aborter.signal, // Optional abort signal, useful for aborting potentially expensive operations
12  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
13});
14
15// This is the basic information we'll get
16
17result.directories; // => Array of absolute paths pointing to directories, filtered by the provided glob
18result.files; // => Array of absolute paths pointing to files, filtered by the provided glob
19result.symlinks; // => Array of absolute paths pointing to symlinks, filtered by the provided glob
20
21// This is more advanced information we'll get, which is useful in some cases
22
23result.directoriesFound; // => Array of absolute paths pointing to directories, not fully filtered by the provided glob yet
24result.filesFound; // => Array of absolute paths pointing to files, not fully filtered by the provided glob yet
25result.symlinksFound; // => Array of absolute paths pointing to symlinks, not fully filtered by the provided glob yet
26
27result.directoriesFoundNames; // => Set of directories names found
28result.filesFoundNames; // => Set of files name found
29result.symlinksFoundNames; // => Set of symlinks names found
30
31result.directoriesFoundNamesToPaths; // => Record of directories names found to their paths
32result.filesFoundNamesToPaths; // => Record of files name found to their paths
33result.symlinksFoundNamesToPaths; // => Record of symlinks names found to their paths
34
35setTimeout ( () => aborter.abort (), 10000 ); // Aborting if it's going to take longer than 10s

License

MIT © Fabio Spampinato