You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1.7 KiB
1.7 KiB
log-update 
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.
// 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