# fs-readdir-recursive

> Recursively read a directory

Latest version **1.1.0** (published 2017-11-10) · MIT license · 0 weekly downloads

## Install

```sh
npm install fs-readdir-recursive
pnpm add fs-readdir-recursive
yarn add fs-readdir-recursive
bun add fs-readdir-recursive
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2017-11-10 |
| First published | 2013-10-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/fs-readdir-recursive) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 63 |
| Author | Jonathan Ong |
| Maintainers | coderhaoxin, fengmk2, dead_horse, swatinem, jongleberry, dead-horse |

## Links

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

## Recent versions

- 1.1.0 (latest) — 2017-11-10
- 1.0.0 — 2015-09-27
- 0.1.2 — 2015-05-18
- 0.1.1 — 2015-03-22
- 0.1.0 — 2014-11-16
- 0.0.2 — 2014-04-30
- 0.0.1 — 2013-10-03

## README

# fs.readdirSyncRecursive

[![NPM version][npm-image]][npm-url]
[![Build status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]
[![Dependency Status][david-image]][david-url]
[![License][license-image]][license-url]
[![Downloads][downloads-image]][downloads-url]
[![Gittip][gittip-image]][gittip-url]

Read a directory recursively.

## Install

```bash
npm install fs-readdir-recursive
```

## Example

```js
var read = require('fs-readdir-recursive')
read(__dirname) === [
  'test/test.js',
  'index.js',
  'LICENSE',
  'package.json',
  'README.md'
]
```

## API

### read(root [, filter])

`root` is the directory you wish to scan. `filter` is an optional filter for the files with three params(name, index, dir). By default, filter is:

```js
function (name) {
  return name[0] !== '.'
}
```

Which basically just ignores `.` files.

[npm-image]: https://img.shields.io/npm/v/fs-readdir-recursive.svg?style=flat-square
[npm-url]: https://npmjs.org/package/fs-readdir-recursive
[github-tag]: http://img.shields.io/github/tag/fs-utils/fs-readdir-recursive.svg?style=flat-square
[github-url]: https://github.com/fs-utils/fs-readdir-recursive/tags
[travis-image]: https://img.shields.io/travis/fs-utils/fs-readdir-recursive.svg?style=flat-square
[travis-url]: https://travis-ci.org/fs-utils/fs-readdir-recursive
[coveralls-image]: https://img.shields.io/coveralls/fs-utils/fs-readdir-recursive.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/fs-utils/fs-readdir-recursive
[david-image]: http://img.shields.io/david/fs-utils/fs-readdir-recursive.svg?style=flat-square
[david-url]: https://david-dm.org/fs-utils/fs-readdir-recursive
[license-image]: http://img.shields.io/npm/l/fs-readdir-recursive.svg?style=flat-square
[license-url]: LICENSE
[downloads-image]: http://img.shields.io/npm/dm/fs-readdir-recursive.svg?style=flat-square
[downloads-url]: https://npmjs.org/package/fs-readdir-recursive
[gittip-image]: https://img.shields.io/gratipay/jonathanong.svg?style=flat-square
[gittip-url]: https://gratipay.com/jonathanong/

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