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