# tiny-readdir

> A simple promisified recursive readdir function.

Latest version **3.1.1** (published 2026-02-22) · MIT license · 0 weekly downloads

## Install

```sh
npm install tiny-readdir
pnpm add tiny-readdir
yarn add tiny-readdir
bun add tiny-readdir
```

## Health

**Score 60/100 (C)** — status: stable.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 3.1.1 |
| Published | 2026-02-22 |
| First published | 2020-11-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 10.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Maintainers | fabiospampinato |
| Keywords | readdir, recursive, promise, simple, tiny |

## Links

- npm: https://www.npmjs.com/package/tiny-readdir
- Repository: https://github.com/fabiospampinato/tiny-readdir
- Homepage: https://github.com/fabiospampinato/tiny-readdir#readme
- Issues: https://github.com/fabiospampinato/tiny-readdir/issues
- npm.io page: https://npm.io/package/tiny-readdir

## Dependencies (1)

- [promise-make-counter](https://npm.io/package/promise-make-counter.md) ^1.0.2

## Alternatives

- [postcss-color-hex-alpha](https://npm.io/package/postcss-color-hex-alpha.md) — 6.4M weekly downloads
- [randomcolor](https://npm.io/package/randomcolor.md) — 348.0K weekly downloads
- [bows](https://npm.io/package/bows.md) — 1.3K weekly downloads
- [ep_prefer_color_scheme](https://npm.io/package/ep_prefer_color_scheme.md) — 260 weekly downloads
- [coc-yank](https://npm.io/package/coc-yank.md) — 61 weekly downloads

## Recent versions

- 3.1.1 (latest) — 2026-02-22
- 3.1.0 — 2026-02-22
- 3.0.0 — 2026-02-22
- 2.7.4 — 2025-01-11
- 2.7.3 — 2024-06-30
- 2.7.2 — 2024-04-06
- 2.7.1 — 2024-04-05
- 2.7.0 — 2024-03-19
- 2.6.0 — 2024-03-18
- 2.5.0 — 2024-03-18
- 2.4.0 — 2023-12-15
- 2.3.0 — 2023-12-01
- 2.2.1 — 2023-11-30
- 2.2.0 — 2022-11-23
- 2.1.0 — 2022-11-19
- … 9 more at https://npm.io/package/tiny-readdir/versions

## README

# Tiny Readdir

A simple promisified recursive readdir function.

## Install

```sh
npm install tiny-readdir
```

## Usage

```ts
import readdir from 'tiny-readdir';

// Let's recursively read into a directory

const aborter = new AbortController ();
const result = await readdir ( '/foo/bar', {
  depth: 20, // Maximum depth to look at
  limit: 1_000_000, // Maximum number of files explored, useful as a stop gap in some edge cases
  followSymlinks: true, // Whether to follow symlinks or not
  ignore: ( targetPath, targetContext ) => /node_modules/.test ( targetPath ), // Function that if returns true will ignore this particular file or a directory and its descendants
  signal: aborter.signal, // Optional abort signal, useful for aborting potentially expensive operations
  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
});

// This is how we would abort the recursive read after 10s

setTimeout ( () => aborter.abort (), 10_000 ); // Aborting if it's going to take longer than 10s

// This is what the result object will look like

result.directories; // => Array of absolute paths pointing to directories
result.files; // => Array of absolute paths pointing to files
result.symlinks; // => Array of absolute paths pointing to symlinks
```

## License

MIT © Fabio Spampinato

---
_Source: https://npm.io/package/tiny-readdir · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._