Installations

npm install totalist

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, ESM

Min. Node Version

>=6

Node Version

18.12.1

NPM Version

8.19.2 Score

99.3

Supply Chain

99.4

Quality

75.5

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

1

Total

3

Closed

0

Merged

2

Issues

Open

1

Total

4

Closed

3

Releases

2

v3.0.1

Updated on Apr 03, 2023

v3.0.0

Updated on Jan 17, 2022

View All 2 releases

Contributors

3

Unable to fetch Contributors

View All 3 Contributors

Languages

1

JavaScript

JavaScript (100%)

validate.email 🚀

Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.

Developer

lukeed

Download Statistics

Total Downloads

954,173,755

Last Day

1,819,625

Last Week

9,310,632

Last Month

38,798,594

Last Year

373,215,385

GitHub Statistics

MIT License

152 Stars

42 Commits

5 Forks

5 Watchers

1 Branches

3 Contributors

Updated on Feb 11, 2025

Bundle Size

642.00 B

Minified

349.00 B

Minified + Gzipped

Bundlephobia

Maintainers

1

Package Meta Information

Latest Version

3.0.1

Package Id

totalist@3.0.1

Unpacked Size

7.28 kB

Size

3.01 kB

File Count

9

NPM Version

8.19.2

Node Version

18.12.1

Published on

Apr 03, 2023

Total Downloads

Cumulative downloads

Total Downloads

954,173,755

Last Day

8.1%

1,819,625

Compared to previous day

Last Week

5.3%

9,310,632

Compared to previous week

Last Month

11.5%

38,798,594

Compared to previous month

Last Year

35%

373,215,385

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

3

bundt esm uvu

totalist

A tiny (195B to 224B) utility to recursively list all (total) files in a directory

Traverse a directory recursively, running a function for every file found.

With this module, you easily apply custom logic to decide which file(s) to process without worrying about accidentally accessing a directory or making repeat fs.Stats requests.

Install

$ npm install --save totalist

Modes

There are two "versions" of totalist available:

"async"

Node.js: >= 8.x
Size (gzip): 220 bytes
Availability: CommonJS, ES Module

This is the primary/default mode. It makes use of async/await and util.promisify.

"sync"

Node.js: >= 6.x
Size (gzip): 195 bytes
Availability: CommonJS, ES Module

This is the opt-in mode, ideal for scenarios where async usage cannot be supported.

Usage

Selecting a Mode

1// import via npm module
2import { totalist } from 'totalist';
3import { totalist } from 'totalist/sync';

Example Usage

1import { totalist } from 'totalist/sync';
2
3const styles = new Set();
4const scripts = new Set();
5
6totalist('src', (name, abs, stats) => {
7  if (/\.js$/.test(name)) {
8    scripts.add(abs);
9    if (stats.size >= 100e3) {
10      console.warn(`[WARN] "${name}" might cause performance issues (${stats.size})`);
11    }
12  } else if (/\.css$/.test(name)) {
13    styles.add(abs);
14  }
15});
16
17console.log([...scripts]);
18//=> [..., '/Users/lukeed/.../src/path/to/example.css', ...]

API

totalist(dir, callback)

Returns: void

Important: The "async" usage must be awaited or included within a Promise chain.

dir

Type: string
Required: true

The directory to traverse.

This may be a relative or an absolute path.

Note: Node.js will assume a relative path is meant to be resolved from the current location (process.cwd()).

callback

Type: Function
Required: true

The callback function to run for every file.

The function receives three parameters:

relPath

Type: String
The path relative to the initial dir value you provided.

absPath

Type: String
The absolute path of the file.

stats

Type: fs.Stats
The fs.Stats object for the file.

License

No vulnerabilities found.

10

Binary-Artifacts

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

10

Dangerous-Workflow

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

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

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

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

CII-Best-Practices

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

0

Security-Policy

Determines if the project has published a security policy.

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.4

/10

Last Scanned on 2025-03-03

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