npmpackage.info

log-update

Log by overwriting the previous output in the terminal. Useful for rendering progress bars, animations, etc.

6.1.0

1,098

MIT

JavaScript

2,892,804,652 4.2

Installations

npm install log-update

Score

Supply Chain

94.6

Quality

76.8

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

32

Closed

14

Merged

18

Issues

Open

5

Total

27

Closed

22

Releases

v6.1.0

Published on 26 Jul 2024

v6.0.0

Published on 28 Oct 2023

v5.0.1

Published on 20 Apr 2022

v5.0.0

Published on 18 Oct 2021

v4.0.0

Published on 20 Feb 2020

v3.4.0

Published on 02 Feb 2020

View all 11 releases

Developer

sindresorhus

Developer Guide

BETA

Module System

ESM

Min. Node Version

>=18

Typescript Support

Yes

Node Version

18.20.2

NPM Version

10.6.0 Statistics

1,098 Stars

66 Commits

40 Forks

11 Watching

1 Branches

16 Contributors

Updated on 22 Nov 2024

Languages

JavaScript (94.43%)

TypeScript (5.57%)

Total Downloads

Cumulative downloads

Total Downloads

2,892,804,652

Last day

-8.7%

3,691,014

Compared to previous day

Last week

1.7%

21,349,853

Compared to previous week

Last month

12.2%

88,152,319

Compared to previous month

Last year

24.8%

855,428,943

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

ansi-escapes cli-cursor slice-ansi strip-ansi wrap-ansi

Dev Dependencies

@types/node ava terminal.js tsd wcwidth xo

Versions

log-update

Log by overwriting the previous output in the terminal.
Useful for rendering progress bars, animations, etc.

Install

1npm install log-update

Usage

1import logUpdate from 'log-update';
2
3const frames = ['-', '\\', '|', '/'];
4let index = 0;
5
6setInterval(() => {
7	const frame = frames[index = ++index % frames.length];
8
9	logUpdate(
10`
11        ♥♥
12   ${frame} unicorns ${frame}
13        ♥♥
14`
15	);
16}, 80);

API

logUpdate(text…)

Log to stdout.

logUpdate.clear()

Clear the logged output.

logUpdate.done()

Persist the logged output.

Useful if you want to start a new log session below the current one.

logUpdateStderr(text…)

Log to stderr.

logUpdateStderr.clear()

logUpdateStderr.done()

createLogUpdate(stream, options?)

Get a logUpdate method that logs to the specified stream.

options

Type: object

showCursor

Type: boolean
Default: false

Show the cursor. This can be useful when a CLI accepts input from a user.

1import {createLogUpdate} from 'log-update';
2
3// Write output but don't hide the cursor
4const log = createLogUpdate(process.stdout, {
5	showCursor: true
6});

Examples

listr - Uses this module to render an interactive task list
ora - Uses this module to render awesome spinners
speed-test - Uses this module to render a spinner

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

4.2

/10

Last Scanned on 2024-11-18

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 log-update

log-update-async-hook

2.0.7

log-update fork that uses async-exit-hook internally

cli-loading-animation

1.0.6

Small library that combine cli-spinners and log-update to display a loading animation in CLI apps made with Node.

elegant-spinner

3.0.0

Elegant spinner for interactive CLI apps

update-notifier

7.3.1

Update notifications for your CLI app