<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## folderReader

Create a stream that outputs the contents of a set of directories recursively

**Parameters**

-   `dirs` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** – The directories to read. Optionally can pass string path of one directory.
-   `options` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `options.fs` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** – alternate fs implementation, optional
    -   `options.encoding` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** – encoding of files, default: utf8
    -   `options.ignore` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** – ignore function for choosing to ignore files and folders, optional
    -   `options.map` **[Function](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/function)** – A function you can use to map the contents of files after they are read, optional

**Examples**

```javascript
var path = require('path')
var reader = require('folder-reader')

var dir = path.join(__dirname, 'docs')
reader(dir).on('data', console.log)
```