# recursive-files

> Asynchronous recursive readdir.

Latest version **1.0.2** (published 2016-06-20) · Fair license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install recursive-files
pnpm add recursive-files
yarn add recursive-files
bun add recursive-files
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2016-06-20 |
| First published | 2014-11-14 |
| Weekly downloads | 0 |
| License | Fair |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Talles L |
| Maintainers | talles |
| Keywords | async, recursive, readdir |

## Links

- npm: https://www.npmjs.com/package/recursive-files
- Repository: https://github.com/tallesl/node-recursive-files
- Homepage: https://github.com/tallesl/node-recursive-files#readme
- Issues: https://github.com/tallesl/node-recursive-files/issues
- npm.io page: https://npm.io/package/recursive-files

## Alternatives

- [promise-throttle](https://npm.io/package/promise-throttle.md) — 44.2K weekly downloads
- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads

## Recent versions

- 1.0.2 (latest) — 2016-06-20
- 1.0.1 — 2015-06-25
- 1.0.0 — 2014-11-14

## README

# recursive-files

[![][build-img]][build]
[![][coverage-img]][coverage]
[![][dependencies-img]][dependencies]
[![][devdependencies-img]][devdependencies]
[![][npm-img]][npm]

Asynchronous recursive [readdir].
Note that the given callback it's called multiple times, one for each found file.

[build]:               https://travis-ci.org/tallesl/node-recursive-files
[build-img]:           https://travis-ci.org/tallesl/node-recursive-files.svg
[coverage]:            https://coveralls.io/r/tallesl/node-recursive-files?branch=master
[coverage-img]:        https://coveralls.io/repos/tallesl/node-recursive-files/badge.svg?branch=master
[dependencies]:        https://david-dm.org/tallesl/node-recursive-files
[dependencies-img]:    https://david-dm.org/tallesl/node-recursive-files.svg
[devdependencies]:     https://david-dm.org/tallesl/node-recursive-files#info=devDependencies
[devdependencies-img]: https://david-dm.org/tallesl/node-recursive-files/dev-status.svg
[npm]:                 https://npmjs.com/package/recursive-files
[npm-img]:             https://badge.fury.io/js/recursive-files.svg
[readdir]:             https://nodejs.org/api/all.html#fs_fs_readdir_path_options_callback

## Usage

```js
recursiveFiles(dir, [options], callback)
```

* **dir** directory path;
* **options**
  * **hidden** list hidden files (files starting with `.`), defaults to `false`
  * **ext** list only files with the provided extension
  * **nonregular** list non regular files such as devices or sockets, defaults to `false`
* **callback** `function (err, file)`
  * **err** eventual error
  * **file** a relative path of the found file to the given directory path;

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