Package Health Score

63 / 100

security
No known security issues
popularity
Popular
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version				Vulnerabilities	License Risk
0.3.1	\|	04/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.3	\|	11/2018		0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.2.2	\|	11/2018	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Popular

Weekly Downloads (49,468)

GitHub Stars: 2.14K
Forks: 50
Contributors: 9

Direct Usage Popularity

The npm package progress-estimator receives a total of 49,468 downloads a week. As such, we scored progress-estimator popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package progress-estimator, we found that it has been starred 2,139 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 9
Funding: Yes

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like progress-estimator is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 1 year ago
Last Commit: 1 year ago

Further analysis of the maintenance status of progress-estimator based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for progress-estimator is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 4 Direct
Versions: 10
Install Size: 13.4 kB
Dist-tags: 1
# of Files: 11
Maintainers: 1
TS Typings: Yes

progress-estimator has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

progress-estimator

Logs a progress bar and estimation for how long a Promise will take to complete. This library tracks previous durations in order to provide more accurate estimates over time.

Demo

🎉 Become a sponsor or ☕ Buy me a coffee

Installation

# use npm
npm install progress-estimator

# use yarn
yarn add progress-estimator

Usage example

const createLogger = require('progress-estimator');
const { join } = require('path');

// All configuration keys are optional, but it's recommended to specify a storage location.
// Learn more about configuration options below.
const logger = createLogger({
  storagePath: join(__dirname, '.progress-estimator'),
});

async function run() {
  await logger(promiseOne, "This is a promise");
  await logger(
    promiseTwo,
    "This is another promise. I think it will take about 1 second",
    {
      estimate: 1000
    }
  );
}

API

`createLogger(optionalConfiguration)`

This method is the default package export. It creates and configures a logger function (documented below). The following configuration options are supported. (They apply only to the logger instance that's returned.)

name	type	Description
`logFunction`	Function	Custom logging function. Defaults to `log-update`. Must define `.done()` and `.clear()` methods.
`spinner`	object	Which spinner from the `cli-spinners` package to use. Defaults to `dots`.
`storagePath`	string	Where to record durations between runs. Defaults to `os.tmpdir()`.
`theme`	object	Custom `chalk` theme. Look to the default theme for a list of required keys.

`logger(promise, labelString, options)`

This method logs a progress bar and estimated duration for a promise. It requires at least two parameters– a Promise and a label (e.g. "Running tests"). The label is SHA1 hashed in order to uniquely identify the promise.

An optional third parameter can be provided as well with the following keys:

name	type	Description
`estimate`	Number	Estimated duration of promise. (This value is used initially, until a history of actual durations have been recorded.)
`id`	String	Uniquely identifies the promise. This value is needed if the label string is not guaranteed to be unique.

progress-estimator dependencies

chalk cli-spinners humanize-duration log-update

progress-estimator development dependencies

babel-eslint eslint eslint-config-prettier eslint-plugin-prettier prettier typescript

FAQs

What is progress-estimator?

Animated progress bars with estimated durations. Visit Snyk Advisor to see a full health score report for progress-estimator, including popularity, security, maintenance & community analysis.

Is progress-estimator popular?

The npm package progress-estimator receives a total of 49,468 weekly downloads. As such, progress-estimator popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is progress-estimator well maintained?

We found indications that progress-estimator is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is progress-estimator safe to use?

The npm package progress-estimator was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 15 April-2024, at 21:19 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

progress-estimator

Animated progress bars with estimated durations For more information about how to use this package see README

Ensure you're using the healthiest npm packages

Package Health Score

Explore Similar Packages

Security

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Popularity

Weekly Downloads (49,468)

Direct Usage Popularity

Community

Embed Package Health Score Badge

Maintenance

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Package

Readme

progress-estimator

🎉 Become a sponsor or ☕ Buy me a coffee

Installation

Usage example

API

`createLogger(optionalConfiguration)`

`logger(promise, labelString, options)`

progress-estimator dependencies

progress-estimator development dependencies

FAQs

What is progress-estimator?

Is progress-estimator popular?

Is progress-estimator well maintained?

Is progress-estimator safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (49,468)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

progress-estimator

🎉 Become a sponsor or ☕ Buy me a coffee

Installation

Usage example

API

createLogger(optionalConfiguration)

logger(promise, labelString, options)

progress-estimator dependencies

progress-estimator development dependencies

FAQs

What is progress-estimator?

Is progress-estimator popular?

Is progress-estimator well maintained?

Is progress-estimator safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

`createLogger(optionalConfiguration)`

`logger(promise, labelString, options)`