Question 1

How to use readdirp with async/await?

Accepted Answer

Use the for-await loop with the stream API, as shown in the README: 'for await (const entry of readdirp('.'))'. This allows asynchronous iteration over entries with minimal memory overhead, making it easy to handle large directories.

Question 2

Readirp vs Node.js fs.readdir with recursion: which is better?

Accepted Answer

Readdirp is better for performance and control, especially with its stream API for large directory trees. Node's built-in methods are simpler for small, synchronous tasks but less efficient and lack built-in filtering options like readdirp.

Question 3

How to filter files by extension in readdirp?

Accepted Answer

Use the fileFilter option with a function, e.g., fileFilter: (f) => f.basename.endsWith('.js'), as demonstrated in the README's promise example. This allows custom logic to include or exclude files based on names or other properties.

Question 4

Does readdirp support symbolic links?

Accepted Answer

Yes, with the lstat: true option, it includes symlink entries in the stream. However, the README warns about recursive symlinks; versions before 3.5 could enter infinite loops, so use with caution and update to avoid issues.

Question 5

How to handle errors in readdirp streams?

Accepted Answer

Listen to the 'warn' event for non-fatal errors (e.g., inaccessible files) and 'error' for fatal ones. The README provides examples, such as logging errors and optionally calling stream.destroy() in 'warn' to abort processing early.

Question 6

Readirp vs glob libraries: what's the difference after v4.0?

Accepted Answer

Since v4.0, readdirp no longer supports glob patterns, so if you need pattern matching, use a dedicated glob library. Readdirp focuses on efficient, recursive directory traversal with custom filtering, not pattern-based file selection.

readdirp

What is readdirp?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions