Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

fs-readdir-recursive

fs-utils13.8mMIT1.1.0TypeScript support: definitely-typed

Recursively read a directory

readme

fs.readdirSyncRecursive

NPM version Build status Test coverage Dependency Status License Downloads Gittip

Read a directory recursively.

Install

npm install fs-readdir-recursive

Example

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:

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

Which basically just ignores . files.