log-update

WebJar for log-update

License	MIT
GroupId	org.webjars.npm
ArtifactId	log-update
Last Version	2.3.0
Release Date	Feb 8, 2019
Type	jar
Description	log-update WebJar for log-update
Project URL	http://webjars.org
Source Code Management	https://github.com/sindresorhus/log-update

Download log-update

Filename	Size
log-update-2.3.0.pom
log-update-2.3.0.jar	4 KB
log-update-2.3.0-sources.jar	22 bytes
log-update-2.3.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/log-update/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>log-update</artifactId>
    <version>2.3.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/log-update/
implementation 'org.webjars.npm:log-update:2.3.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/log-update/
implementation ("org.webjars.npm:log-update:2.3.0")

Apache Buildr

'org.webjars.npm:log-update:jar:2.3.0'

Apache Ivy

<dependency org="org.webjars.npm" name="log-update" rev="2.3.0">
  <artifact name="log-update" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='log-update', version='2.3.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "log-update" % "2.3.0"

Leiningen

[org.webjars.npm/log-update "2.3.0"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.webjars.npm : ansi-escapes	jar	[3.0.0,4)
org.webjars.npm : cli-cursor	jar	[2.0.0,3)
org.webjars.npm : wrap-ansi	jar	[3.0.1,4)

Project Modules

There are no modules declared in this project.

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.

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.}

Versions

Version
2.3.0 Feb 8, 2019
1.0.2 Feb 12, 2016