readdirp-async

Yet another "readdirp" implementation that's an async generator.

Install

1npm install readdirp-async

API

1import r from 'readdirp-async'

r(path, opts)

• path <string> Root path to start reading dir
• [opts.depth] [number] Depth to scan down to

for await(const output of r(…))

• output.path [string] Path of the descendant
• output.dirent [dirent] instance
• output.depth [number] Current depth
• output.parent [string] Parent path

r(…).next(input)

• input.skip [boolean] Skip current directory (and all its descendants)
• You can also assign these to output

Example

1const r = require('readdirp-async')
2
3for await(const o of r(__dirname)) {
4  if (o.path.includes('node_modules')) {
5    // Skip commonly ignored directories and their contents
6    o.skip = true
7    continue;
8  } else {
9    // do any operations
10    await fs.copy(o.item, …)
11  }
12}