Use multiple CPU cores via clusters for the fastest way to read nested directories and their stats
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
source
.editorconfig
.eslintrc.js
.gitignore
.npmignore
.travis.yml
CONTRIBUTING.md
HISTORY.md
LICENSE.md
README.md
example.js
index.js
package-lock.json
package.json
test.js

README.md

readdir-cluster

Travis CI Build Status NPM version NPM downloads Dependency Status Dev Dependency Status
Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button
Slack community badge

Use multiple CPU cores via clusters for the fastest way to read nested directories and their stats

Install

NPM

  • Install: npm install --save readdir-cluster
  • Module: require('readdir-cluster')

Editions

This package is published with the following editions:

  • readdir-cluster aliases readdir-cluster/index.js which uses Editions to automatically select the correct edition for the consumers environment
  • readdir-cluster/source/index.js is Source + ESNext + Require
  • readdir-cluster/es2015/index.js is Babel Compiled + ES2015 + Require

Older environments may need Babel's Polyfill or something similar.

Usage

const readdir = require('readdir-cluster')
const paths = []

function iterator (fullPath, relativePath, statObject) {
	if ( statObject.directory && relativePath[0] === '.' ) {
		return false  // do not delve deeper into hidden paths
	}
	paths.push(fullPath)
}

readdir(__dirname, iterator, function (err) {
	if (err)  throw err
	console.log('completed successfully:', paths)
})

History

Discover the release history by heading on over to the HISTORY.md file.

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Open Collective donate button Gratipay donate button Flattr donate button PayPal donate button Bitcoin donate button Wishlist browse button

Contributors

These amazing people have contributed code to this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

License

Unless stated otherwise all works are:

and licensed under: