@lunjs/readdirp

Recursive version of fs.readdir. Exposes a stream API and a promise API.

Installation

1npm install @lunjs/readdirp

Usage

1import { readdirp } from '@lunjs/readdirp';
2
3// Use streams to achieve small RAM & CPU footprint.
4// 1) Streams example with for-await.
5for await (const entry of readdirp('.')) {
6  const { path } = entry;
7  console.log(`${JSON.stringify({ path })}`);
8}
9
10// 2) Streams example, non for-await.
11// Print out all JS files along with their size within the current folder & subfolders.
12readdirp('.', { fileFilter: '*.js', alwaysStat: true })
13  .on('data', (entry) => {
14    const { path, stats: { size } } = entry;
15    console.log(`${JSON.stringify({ path, size })}`);
16  })
17  // Optionally call stream.destroy() in `warn()` in order to abort and cause 'close' to be emitted
18  .on('warn', error => console.error('non-fatal error', error))
19  .on('error', error => console.error('fatal error', error))
20  .on('end', () => console.log('done'));
21
22// 3) Promise example. More RAM and CPU than streams / for-await.
23const files = await readdirp('.');
24console.log(files.map(file => file.path));

For more examples, check out examples directory.

Acknowledgements

Forked from paulmillr/readdirp.

License

MIT