Home
Docs
GitHub
Pricing
Blog
Log In

Run Sandworm Audit for your App

Get started
Hold on, we're currently generating a fresh version of this report
Generated on May 18, 2024 via pnpm

gauge 2.7.4

A terminal based horizontal guage
Package summary
Share
0
issues
2
licenses
7
MIT
6
ISC
Package created
5 Jan 2015
Version published
21 Apr 2017
Maintainers
5
Total deps
13
Direct deps
8
License
ISC

Issues

0
This package has no issues

Licenses

MIT License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
sublicense
private-use
Cannot
hold-liable
Must
include-copyright
include-license
7 Packages, Including:
ansi-regex@2.1.1
code-point-at@1.1.0
is-fullwidth-code-point@1.0.0
number-is-nan@1.0.1
object-assign@4.1.1
string-width@1.0.2
strip-ansi@3.0.1

ISC License

Permissive
OSI Approved
This is a human-readable summary of (and not a substitute for) the license. Disclaimer.
Can
commercial-use
modify
distribute
Cannot
hold-liable
Must
include-copyright
include-license
6 Packages, Including:
aproba@1.2.0
console-control-strings@1.1.0
gauge@2.7.4
has-unicode@2.0.1
signal-exit@3.0.7
wide-align@1.1.5
Disclaimer

This deed highlights only some of the key features and terms of the actual license. It is not a license and has no legal value. You should carefully review all of the terms and conditions of the actual license before using the licensed material.

Sandworm is not a law firm and does not provide legal services. Distributing, displaying, or linking to this deed or the license that it summarizes does not create a lawyer-client or any other relationship.

Direct Dependencies

8
All Dependencies CSV
ⓘ This is a list of gauge 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.
NameVersionSizeLicenseTypeVulnerabilities
aproba1.2.03.44 kBISC
prod
console-control-strings1.1.03.26 kBISC
prod
has-unicode2.0.11.92 kBISC
prod
object-assign4.1.12.61 kBMIT
prod
signal-exit3.0.73.76 kBISC
prod
string-width1.0.22.03 kBMIT
prod
strip-ansi3.0.11.69 kBMIT
prod
wide-align1.1.51.95 kBISC
prod

Visualizations

Frequently Asked Questions

What does gauge do?

Gauge is a nearly stateless terminal-based Horizontal Gauge / Progress Bar. It provides users with a dynamic interface to display status information during the execution of tasks. The gauge updates are represented visually on a single line, and it takes into account terminal resizes, responsively adapting its size accordingly.

How do you use gauge?

To use Gauge in your Node.js project, first install the package by running npm install gauge. After installation, you can start using it by requiring it in your desired file. Here's a basic usage example:

var Gauge = require("gauge")

var gauge = new Gauge()

gauge.show("working…", 0)
setTimeout(() => { gauge.pulse(); gauge.show("working…", 0.25) }, 500)
setTimeout(() => { gauge.pulse(); gauge.show("working…", 0.50) }, 1000)
setTimeout(() => { gauge.pulse(); gauge.show("working…", 0.75) }, 1500)
setTimeout(() => { gauge.pulse(); gauge.show("working…", 0.99) }, 2000)
setTimeout(() => gauge.hide(), 2300)

In the above example, Gauge() initializes a new gauge instance. The gauge.show() function updates the text and progress of the gauge over time, while gauge.pulse() animates a spinner in the progress bar. Finally gauge.hide() removes the gauge from the terminal.

Where are the gauge docs?

The documentation for the Gauge package is available in its README file, which can be found on its GitHub page here. The documentation includes more detailed instructions for various functions and options you can utilize when creating and manipulating your Gauge. Also, additional demos and usage examples can be found in the /docs folder of the package's GitHub repository.