blob: d31b672075958e7a6f68bd4bdd92a171c59747fa (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
# log-update [](https://travis-ci.org/sindresorhus/log-update)
> Log by overwriting the previous output in the terminal.<br>
> Useful for rendering progress bars, animations, etc.
## Install
```
$ npm install log-update
```
## Usage
```js
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.<br>
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`<br>
Default: `false`
Show the cursor. This can be useful when a CLI accepts input from a user.
```js
// Write output but don't hide the cursor
const log = logUpdate.create(process.stdout, {
showCursor: true
});
```
## Examples
- [listr](https://github.com/SamVerschueren/listr) - Uses this module to render an interactive task list
- [ora](https://github.com/sindresorhus/ora) - Uses this module to render awesome spinners
- [speed-test](https://github.com/sindresorhus/speed-test) - Uses this module to render a [spinner](https://github.com/sindresorhus/elegant-spinner)
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)
|
