npmpackage.info

Gathering detailed insights and metrics for readdir-cluster

readdir-cluster

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

6.0.0

NOASSERTION

TypeScript

96.90 kB

3.5

Installations

npm install readdir-cluster

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=4

Node Version

20.10.0

NPM Version

10.2.3 Score

Supply Chain

99.4

Quality

76.2

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

163

Closed

132

Merged

31

Issues

Open

4

Total

8

Closed

4

Releases

Unable to fetch releases

Languages

TypeScript

JavaScript

TypeScript (90.1%)

JavaScript (9.9%)

Developer

bevry

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

NOASSERTION License

10 Stars

77 Commits

2 Forks

1 Watchers

2 Branches

2 Contributors

Updated on May 27, 2024

Sponsor this package

https://bevry.me/fund

Maintainers

View All 2 Contributors

Package Meta Information

Latest Version

6.0.0

Package Id

readdir-cluster@6.0.0

Unpacked Size

96.90 kB

Size

19.43 kB

File Count

NPM Version

10.2.3

Node Version

20.10.0

Published on

Dec 30, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

editions

Dev Dependencies

@types/node @typescript-eslint/eslint-plugin @typescript-eslint/parser assert-helpers eslint eslint-config-bevry eslint-config-prettier eslint-plugin-prettier filedirname kava prettier projectz typedoc typescript valid-directory

readdir-cluster

Create a cluster of workers to iterate through the filesystem

Usage

Complete API Documentation.

1import readdirCluster, { Stat } from 'readdir-cluster'
2
3// note that Stat is not the same as fs.Stats as it has functions removed, as it needed to be serialisable
4function iterator(path: string, filename: string, stat: Stat) {
5    // skip directories and files that start with .
6    if (filename[0] === '.') return false
7    // do not recurse into directories
8    if (stat.directory) return false
9}
10
11const paths = await readdirCluster({ directory: '.', iterator })
12console.log(paths)

Performance

Running readdir-cluster . returns 7388 files in 500ms

Running readdir with recursive: true returns 7388 files in 100ms

1import { readdir } from 'fs'
2readdir('.', { recursive: true }, (err, files) => {
3    if (err) console.error(err)
4    else if (files.length) process.stdout.write(files.join('\n') + '\n')
5})

Running fdir returns 6480 files in 100ms

1import { fdir } from 'fdir'
2const api = new fdir().withBasePath().crawl(process.argv[2])
3api.withPromise().then((files) => {
4    if (files.length) process.stdout.write(files.join('\n') + '\n')
5})

As such, you should probably use readdir with recursive: true or fdir instead. As for why this package exists, readdir-cluster was created in 2005, recursive was added to Node.js in 2023, and fdir was created in 2020. That said, there are several issues that could potentially improve readdir-cluster performance.

Install

npm

Install Globally

Install: npm install --global readdir-cluster
Executable: readdir-cluster

Install Locally

Install: npm install --save readdir-cluster
Executable: npx readdir-cluster
Import: import pkg from ('readdir-cluster')
Require: const pkg = require('readdir-cluster').default

Editions

This package is published with the following editions:

readdir-cluster aliases readdir-cluster/index.cjs which uses the Editions Autoloader to automatically select the correct edition for the consumer's environment
readdir-cluster/source/index.ts is TypeScript source code with Import for modules
readdir-cluster/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js 14 || 16 || 18 || 20 || 21 with Require for modules
readdir-cluster/edition-es2017/index.js is TypeScript compiled against ES2017 for Node.js 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
readdir-cluster/edition-es2015/index.js is TypeScript compiled against ES2015 for Node.js 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
readdir-cluster/edition-es5/index.js is TypeScript compiled against ES5 for Node.js 4 || 6 || 8 || 10 || 12 || 14 || 16 || 18 || 20 || 21 with Require for modules
readdir-cluster/edition-es2017-esm/index.js is TypeScript compiled against ES2017 for Node.js 12 || 14 || 16 || 18 || 20 || 21 with Import for modules
readdir-cluster/edition-types/index.d.ts is TypeScript compiled Types with Import for modules

History

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

Backers

Code

Discover how to contribute via the CONTRIBUTING.md file.

Authors

Benjamin Lupton — Accelerating collaborative wisdom.

Maintainers

Benjamin Lupton — Accelerating collaborative wisdom.

Contributors

Benjamin Lupton — view contributions

Finances

Donors

License

Unless stated otherwise all works are:

and licensed under:

Artistic License 2.0

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Security-Policy

Determines if the project has published a security policy.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

9

License

Determines if the project has defined a license.

4

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

0

Maintained

Determines if the project is "actively maintained".

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

3.5

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

readdir-cluster - 6.0.0 | npmpackage.info

readdir-cluster

Installations

Developer Guide

Yes

ESM

>=4

20.10.0

10.2.3

Score

Pull Requests

0

163

132

31

Issues

4

8

4

Releases

Unable to fetch releases

Languages

Developer

bevry

Download Statistics

GitHub Statistics

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

readdir-cluster

Usage

Performance

Install

npm

Install Globally

Install Locally

Editions

History

Backers

Code

Authors

Maintainers

Contributors

Finances

Sponsors

Donors

License

10

10

10

9

4

0

0

0

0

0

0

0

0

3.5

/10