log-update
Log by overwriting the previous output in the terminal. Useful for rendering progress bars, animations, etc.
Last updated 3 months ago by sindresorhus .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install log-update 
SYNC missed versions from official npm registry.

log-update Build Status

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

Install

$ npm install log-update

Usage

const logUpdate = require('log-update');

const frames = ['-', '\\', '|', '/'];
let i = 0;

setInterval(() => {
	const frame = frames[i = ++i % frames.length];

	logUpdate(
`
        ♥♥
   ${frame} unicorns ${frame}
        ♥♥
`
	);
}, 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.

logUpdate.stderr(text…)

Log to stderr.

logUpdate.stderr.clear()

logUpdate.stderr.done()

logUpdate.create(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.

const logUpdate = require('log-update');

// Write output but don't hide the cursor
const log = logUpdate.create(process.stdout, {
	showCursor: true
});

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

License

MIT © Sindre Sorhus

Current Tags

  • 3.3.0                                ...           latest (3 months ago)

12 Versions

  • 3.3.0                                ...           3 months ago
  • 3.2.0                                ...           8 months ago
  • 3.1.1                                ...           8 months ago
  • 3.1.0                                ...           9 months ago
  • 3.0.0                                ...           9 months ago
  • 2.3.0                                ...           2 years ago
  • 2.2.0                                ...           2 years ago
  • 2.1.0                                ...           2 years ago
  • 2.0.0                                ...           3 years ago
  • 1.0.2                                ...           4 years ago
  • 1.0.1                                ...           4 years ago
  • 1.0.0                                ...           4 years ago
Maintainers (1)
Downloads
Today 5,926
This Week 29,645
This Month 127,654
Last Day 7,492
Last Week 42,354
Last Month 147,571
Dependencies (3)
Dev Dependencies (5)
Dependents (697)

Copyright 2014 - 2017 © taobao.org |