readdir-sync-recursive

AndrewMusgrave
js
readdir-sync-recursive JS library on GitHub readdir-sync-recursive JS library on npm Download readdir-sync-recursive JS library

Recursively crawl through directories

Version 1.0.0 License MIT
readdir-sync-recursive has no homepage
readdir-sync-recursive JS library on GitHub
readdir-sync-recursive JS library on npm
Download readdir-sync-recursive JS library
Keywords
dirdirectoryreaddirfs-readdirrecursive-readdirrecursive-readdir-syncreadfolderparsefilecrawlrecursivesyncfsperformance
INSTALL
Type:
Version:
<script type="module"> import readdirSyncRecursive from 'https://cdn.jsdelivr.net/npm/readdir-sync-recursive@1.0.0/+esm' </script>
Learn more
Readme Files Statistics Browse CDN

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