b06d087366b9eb7514f7a85bed4370e3629571790b382138b83198b3ad31eff12aae694782594170140a75868c68a538650afa388e2c5289e51d6d8961db0e 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. # fs.readdirSyncRecursive
  2. [![NPM version][npm-image]][npm-url]
  3. [![Build status][travis-image]][travis-url]
  4. [![Test coverage][coveralls-image]][coveralls-url]
  5. [![Dependency Status][david-image]][david-url]
  6. [![License][license-image]][license-url]
  7. [![Downloads][downloads-image]][downloads-url]
  8. [![Gittip][gittip-image]][gittip-url]
  9. Read a directory recursively.
  10. ## Install
  11. ```bash
  12. npm install fs-readdir-recursive
  13. ```
  14. ## Example
  15. ```js
  16. var read = require('fs-readdir-recursive')
  17. read(__dirname) === [
  18. 'test/test.js',
  19. 'index.js',
  20. 'LICENSE',
  21. 'package.json',
  22. 'README.md'
  23. ]
  24. ```
  25. ## API
  26. ### read(root [, filter])
  27. `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:
  28. ```js
  29. function (name) {
  30. return name[0] !== '.'
  31. }
  32. ```
  33. Which basically just ignores `.` files.
  34. [npm-image]: https://img.shields.io/npm/v/fs-readdir-recursive.svg?style=flat-square
  35. [npm-url]: https://npmjs.org/package/fs-readdir-recursive
  36. [github-tag]: http://img.shields.io/github/tag/fs-utils/fs-readdir-recursive.svg?style=flat-square
  37. [github-url]: https://github.com/fs-utils/fs-readdir-recursive/tags
  38. [travis-image]: https://img.shields.io/travis/fs-utils/fs-readdir-recursive.svg?style=flat-square
  39. [travis-url]: https://travis-ci.org/fs-utils/fs-readdir-recursive
  40. [coveralls-image]: https://img.shields.io/coveralls/fs-utils/fs-readdir-recursive.svg?style=flat-square
  41. [coveralls-url]: https://coveralls.io/r/fs-utils/fs-readdir-recursive
  42. [david-image]: http://img.shields.io/david/fs-utils/fs-readdir-recursive.svg?style=flat-square
  43. [david-url]: https://david-dm.org/fs-utils/fs-readdir-recursive
  44. [license-image]: http://img.shields.io/npm/l/fs-readdir-recursive.svg?style=flat-square
  45. [license-url]: LICENSE
  46. [downloads-image]: http://img.shields.io/npm/dm/fs-readdir-recursive.svg?style=flat-square
  47. [downloads-url]: https://npmjs.org/package/fs-readdir-recursive
  48. [gittip-image]: https://img.shields.io/gratipay/jonathanong.svg?style=flat-square
  49. [gittip-url]: https://gratipay.com/jonathanong/