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

Published on 03 Apr 2023

v3.0.0

Published on 17 Jan 2022

View all 2 releases

Contributors

3

Unable to fetch Contributors

View all 3 contributors

Languages

1

JavaScript

JavaScript (100%)

Developer

lukeed

Download Statistics

Total Downloads

870,653,423

Last Day

562,642

Last Week

3,443,763

Last Month

29,012,729

Last Year

352,246,846

GitHub Statistics

153 Stars

42 Commits

5 Forks

6 Watching

1 Branches

3 Contributors

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

Publised On

03 Apr 2023

Total Downloads

Cumulative downloads

Total Downloads

870,653,423

Last day

-16%

562,642

Compared to previous day

Last week

-45.6%

3,443,763

Compared to previous week

Last month

-8%

29,012,729

Compared to previous month

Last year

35.4%

352,246,846

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

3

bundt esm uvu

Versions

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

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

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

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-01-06

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