readdir-sync-recursive

1.0.0 • Public • Published

readdirSyncRecursive

Read a directory recursively.

Install

npm install readdir-sync-recursive

Usage

// list of directories
const readdirSync = require('readdir-sync-recursive')
const readdirSync('./src');
 
// with callbacks
const readdirSync = require('readdir-sync-recursive')
const readdirSync('./src', onDir, onFile);
 
// ingore callback
const readdirSync = require('readdir-sync-recursive')
const readdirSync('./src', null, null, ignoreDir);

API

readdirSync(dir, onDir, onFile, ignoreDir)

Param Type Default Description
dir string directory path
onDir (filePath: string): void or any callback with a directory is found
onFile (filePath: string): void or any callback with a file is found
ignoreDir ?(filePath: string): boolean or undefined (): false function to determine if a file or directory should be ignored

Package Sidebar

Install

npm i readdir-sync-recursive

Weekly Downloads

2

Version

1.0.0

License

MIT

Unpacked Size

3.15 kB

Total Files

3

Last publish

Collaborators

  • andrewmusgrave