Big update!Introducing GitHub Bot Commands. Learn more
Socket
Log inBook a demo

log-update

Package Overview
Dependencies
5
Maintainers
1
Versions
16
Issues
File Explorer

Advanced tools

log-update

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

    5.0.1latest

Version published
Maintainers
1
Weekly downloads
11,077,349
decreased by-12.25%

Weekly downloads

Changelog

Source

  • Fix height truncation when using styled text (#57) 81b1229

https://github.com/sindresorhus/log-update/compare/v5.0.0...v5.0.1

Readme

Source

log-update

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

Install

npm install log-update

Usage

import logUpdate from 'log-update'; const frames = ['-', '\\', '|', '/']; let index = 0; setInterval(() => { const frame = frames[index = ++index % 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.

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.

import logUpdate from '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.

Keywords

FAQs

What is log-update?

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

Is log-update popular?

The npm package log-update receives a total of 8,802,167 weekly downloads. As such, log-update popularity was classified as popular.

Is log-update well maintained?

We found that log-update demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago.It has 1 open source maintainer collaborating on the project.

Last updated on 20 Apr 2022

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket

Product

Subscribe to our newsletter

Get open source security insights delivered straight into your inbox. Be the first to learn about new features and product updates.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc