# fs-readdir-rec-gen

**Repository Path**: mirrors_Orange-OpenSource/fs-readdir-rec-gen

## Basic Information

- **Project Name**: fs-readdir-rec-gen
- **Description**: Get an ES6 generator for files in a directory and subdirectories
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-02-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# A recursive read dir, generator based implementation

[![Build Status](https://travis-ci.org/Orange-OpenSource/fs-readdir-rec-gen.svg?branch=master)](https://travis-ci.org/Orange-OpenSource/fs-readdir-rec-gen)
[![Coverage Status](https://coveralls.io/repos/github/Orange-OpenSource/fs-readdir-rec-gen/badge.svg?branch=master)](https://coveralls.io/github/Orange-OpenSource/fs-readdir-rec-gen?branch=master)
[![Installs!](https://img.shields.io/npm/dm/fs-readdir-rec-gen.svg)](https://www.npmjs.com/package/fs-readdir-rec-gen)
[![npm](https://img.shields.io/npm/v/fs-readdir-rec-gen.svg)](https://www.npmjs.com/package/fs-readdir-rec-gen)
[![License](https://img.shields.io/npm/l/fs-readdir-rec-gen.svg)](LICENSE.txt)

A NodeJS module to get a generator for files in a directory and subdirectories, with a file filter capability.

# Install

```bash
npm install --save fs-readdir-rec-gen
```

# API

```js
fsReadDirRecGen(dir [, options] [, filter] [, recursive=true])
```

* ```dir``` {String} - the directory where to look for files.
* ```options``` {String|Object} - optional, options passed NodeJs File System API (see [NodeJS' fs API](https://nodejs.org/api/fs.html#fs_fs_readdir_path_options_callback)).
* ```filter``` {Function} - optional, a function to filter on file names. Defaults to no filter.
* ```recursive``` {Boolean} - optional, whether to search in sub directories. Defaults to true.

If ```dir``` does not exists, an exception is immediately thrown by NodeJS' ```fs``` API.

# Examples
With a simple .js file filter:
```js
var fsReadDirRecGen = require('fs-readdir-rec-gen')

function dotJsFilesFilter(fileName) {
    return fileName.endsWith('.js');
};
for (let file of fsReadDirRecGen('./test/testData', dotJsFilesFilter)) {
    console.log('Relative path to file : ' + file);
}
```
```
Relative path to file : test/testData/aa/class3.js
Relative path to file : test/testData/abstractsuperclass.js
Relative path to file : test/testData/class.js
Relative path to file : test/testData/class2.js
```

With a RegExp file filter:
```js
var fsReadDirRecGen = require('fs-readdir-rec-gen')

function classdotJsFileFilter() {
    var format = RegExp(/.*class.*\.js/i);
    return function (filename) {
        return format.test(filename);
    }
};
for (let file of fsReadDirRecGen('./test/testData', classdotJsFileFilter())){
    console.log('Relative path to file : ' + file);
}
```

Without file filter:
```js
var fsReadDirRecGen = require('fs-readdir-rec-gen')

for (let file of fsReadDirRecGen('./test/testData')){
    console.log('Relative path to file : ' + file);
}
```

More examples in [examples.js](examples.js) and [test dir](test).