Have ideas to improve npm?Join in the discussion! »

log-update

4.0.0 • Public • Published

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[= ++% 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

Get professional support for this package with a Tidelift subscription
Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.

Install

npm i log-update

DownloadsWeekly Downloads

6,136,940

Version

4.0.0

License

MIT

Unpacked Size

7.58 kB

Total Files

5

Last publish

Collaborators

  • avatar