npmpackage.info

loading-cli

Terminal loading effect.

1.1.2

JavaScript

1.59 kB

Installations

npm install loading-cli

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

18.18.2

NPM Version

9.8.1 Score

89.8

Supply Chain

100

Quality

75.7

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

4

Closed

1

Merged

3

Issues

Open

3

Total

4

Closed

1

Releases

v1.1.2

Published on 27 Nov 2023

v1.1.1

Published on 16 Oct 2023

v1.1.0

Published on 03 Oct 2021

v1.0.6

Published on 20 Jan 2018

View all 4 releases

Contributors

Unable to fetch Contributors

View all 2 contributors

Languages

JavaScript

JavaScript (100%)

Developer

jaywcjlove

Download Statistics

Total Downloads

1,215,048

Last Day

2,342

Last Week

10,381

Last Month

53,857

Last Year

625,548

GitHub Statistics

54 Stars

51 Commits

6 Forks

4 Watching

2 Branches

2 Contributors

Bundle Size

4.94 kB

Minified

1.59 kB

Minified + Gzipped

Bundlephobia

Sponsor this package

https://jaywcjlove.github.io/#/sponsor

Maintainers

Package Meta Information

Latest Version

1.1.2

Package Id

loading-cli@1.1.2

Unpacked Size

10.29 kB

Size

3.56 kB

File Count

NPM Version

9.8.1

Node Version

18.18.2

Publised On

27 Nov 2023

Total Downloads

Cumulative downloads

Total Downloads

1,215,048

Last day

-12.6%

2,342

Compared to previous day

Last week

-26.1%

10,381

Compared to previous week

Last month

6.3%

53,857

Compared to previous month

Last year

76.9%

625,548

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

colors-cli

Versions

loading-cli

Terminal loading effect.

Install

1$ npm install --save loading-cli

Usage

1const loading =  require('loading-cli');
2const load = loading("loading text!!").start()
3
4setTimeout(function(){
5    load.color = 'yellow';
6    load.text = ' Loading rainbows';
7},2000)
8
9// stop
10setTimeout(function(){
11    load.stop()
12},3000)

Custom text color colors-cli

1const color = require('colors-cli/toxic');
2const loading = require('loading-cli');
3
4const load = loading("loading text!!".blue).start();
5// stop
6setTimeout(function(){
7  load.stop()
8},3000)

API

loading([options|text])

options

1load({
2  "text":"loading text!!",
3  "color":"yellow",
4  "interval":100,
5  "stream": process.stdout,
6  "frames":["◰", "◳", "◲", "◱"]
7})

text

Type: string Text to display after the spinner.

1loading("loading text!!")

color

Values:black red green yellow blue magenta cyan white gray

frames

1["◰", "◳", "◲", "◱"]
2["◐", "◓", "◑", "◒"]
3[".", "o", "O", "°", "O", "o", "."]
4["⊶", "⊷"]
5["ဝ", "၀"]
6["←", "↖", "↑", "↗", "→", "↘", "↓", "↙"]
7["🕐 ", "🕑 ", "🕒 ", "🕓 ", "🕔 ", "🕕 ", "🕖 ", "🕗 ", "🕘 ", "🕙 ", "🕚 "]

Instance

.start([text])

Start the spinner. Returns the instance.

.stop()

Stop and clear the spinner. Returns the instance.

.clear()

Clear the spinner. Returns the instance.

.succeed([text])

Stop the spinner, change it to a green ✔ and persist the current text, or text if provided. Returns the instance. See the GIF below.

.fail([text])

Stop the spinner, change it to a red ✖ and persist the current text, or text if provided. Returns the instance. See the GIF below.

.warn([text])

Stop the spinner, change it to a yellow ⚠ and persist the current text, or text if provided. Returns the instance.

.info([text])

Stop the spinner, change it to a blue ℹ and persist the current text, or text if provided. Returns the instance.

.render()

Manually render a new frame. Returns the instance.

.frame()

Get a new frame.

1const loading = require('loading-cli');
2const load = loading("loading text!!");
3load.frame(["◰", "◳", "◲", "◱"]);
4load.start();

.text

Change the text.

.color

Change the spinner color.

Contributors

As always, thanks to our amazing contributors!

Made with contributors.

License

Licensed under the MIT 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

Packaging

Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

9

Token-Permissions

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

0

Maintained

Determines if the project is "actively maintained".

0

CII-Best-Practices

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

0

Code-Review

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

0

Pinned-Dependencies

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

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

Score

4.7

/10

Last Scanned on 2025-01-27

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

Other packages similar to loading-cli

cli-spinners

3.2.0

Spinners for use in the terminal

ora

8.2.0

Elegant terminal spinner

listr2

8.2.5

Terminal task list reborn! Create beautiful CLI interfaces via easy and logical to implement task lists that feel alive and interactive.

elegant-spinner

3.0.0

Elegant spinner for interactive CLI apps