@fibcli/log-update


This repo is migration from https://github.com/sindresorhus/log-update, for fibjs.

log-update

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


Install

``sh
npm install @fibcli/log-update
`

Usage

`js
import logUpdate from '@fibcli/log-update';

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

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

logUpdate(

♥♥
${frame} unicorns ${frame}
♥♥

);
}, 80);
`

API

$3

Log to stdout.

$3

Clear the logged output.

$3

Persist the logged output.

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

$3

Log to stderr.

$3

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.

`js
import logUpdate from '@fibcli/log-update';

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