readdirsync2

readdirSync with some useful options: recursively, exclude name and ext, get only file or directory.

Installation



npm install readdirsync2 --save





Example



#### Basic usage

javascript

const readdirSync = require('readdirsync2');

readdirSync('./foo/bar');





#### Get only files

javascript

readdirSync('./foo/bar', {only: 'file'});





#### Get only directories

javascript

readdirSync('./foo/bar', {only: 'directory'});





#### Disable recursive mode

javascript

readdirSync('./foo/bar', {recursive: false});





#### Ignore files with extension

javascript

readdirSync('./foo/bar', {ignoreExt: ['.js', '.txt']});





#### Ignore files or directories with name

javascript

readdirSync('./foo/bar', {ignoreName: ['index.js', 'my-folder']});

Read directory content

Kind: global function

Param	Type	Default	Description
dir	`string`		directory path
[opts]	`Object`		options
[opts.ignoreExt]	`Array`	`[]`	an array of extensions to ignore, eg: '.txt'
[opts.ignoreName]	`Array`	`[]`	an array of filename or directory to ignore, eg: 'index.js'
[opts.only]	`string`		get file or directory or both. The value can be: `file` or `directory`
[opts.recursive]	`boolean`	`true`	lookup also in nested directories

You can view the changelog here

readdirsync2 is open-sourced software licensed under the MIT license

readdirSync with some useful options: recursively, exclude name and ext, get only file or directory.



npm install readdirsync2 --save





Example



#### Basic usage

javascript

const readdirSync = require('readdirsync2');

readdirSync('./foo/bar');





#### Get only files

javascript

readdirSync('./foo/bar', {only: 'file'});





#### Get only directories

javascript

readdirSync('./foo/bar', {only: 'directory'});





#### Disable recursive mode

javascript

readdirSync('./foo/bar', {recursive: false});





#### Ignore files with extension

javascript

readdirSync('./foo/bar', {ignoreExt: ['.js', '.txt']});





#### Ignore files or directories with name

javascript

readdirSync('./foo/bar', {ignoreName: ['index.js', 'my-folder']});

Read directory content

Kind: global function

Param	Type	Default	Description
dir	`string`		directory path
[opts]	`Object`		options
[opts.ignoreExt]	`Array`	`[]`	an array of extensions to ignore, eg: '.txt'
[opts.ignoreName]	`Array`	`[]`	an array of filename or directory to ignore, eg: 'index.js'
[opts.only]	`string`		get file or directory or both. The value can be: `file` or `directory`
[opts.recursive]	`boolean`	`true`	lookup also in nested directories

You can view the changelog here

readdirsync2 is open-sourced software licensed under the MIT license