diff options
Diffstat (limited to 'node_modules/npmlog/README.md')
| -rw-r--r-- | node_modules/npmlog/README.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/node_modules/npmlog/README.md b/node_modules/npmlog/README.md index ad67688d7..a57cf429d 100644 --- a/node_modules/npmlog/README.md +++ b/node_modules/npmlog/README.md @@ -80,6 +80,26 @@ stream. Disable colors on all messages. +## log.enableProgress() + +Enable the display of log activity spinner and progress bar + +## log.disableProgress() + +Disable the display of a progress bar + +## log.enableUnicode() + +Force the unicode theme to be used for the progress bar. + +## log.disableUnicode() + +Disable the use of unicode in the progress bar. + +## log.setGaugeTemplate(template) + +Overrides the default gauge template. + ## log.pause() Stop emitting messages to the stream, but do not drop them. @@ -123,6 +143,28 @@ Note that if the number is `Infinity`, then setting the level to that will cause all log messages to be suppressed. If the number is `-Infinity`, then the only way to show it is to enable all log messages. +## log.newItem(name, todo, weight) + +* `name` {String} Optional; progress item name. +* `todo` {Number} Optional; total amount of work to be done. Default 0. +* `weight` {Number} Optional; the weight of this item relative to others. Default 1. + +This adds a new `are-we-there-yet` item tracker to the progress tracker. The +object returned has the `log[level]` methods but is otherwise an +`are-we-there-yet` `Tracker` object. + +## log.newStream(name, todo, weight) + +This adds a new `are-we-there-yet` stream tracker to the progress tracker. The +object returned has the `log[level]` methods but is otherwise an +`are-we-there-yet` `TrackerStream` object. + +## log.newGroup(name, weight) + +This adds a new `are-we-there-yet` tracker group to the progress tracker. The +object returned has the `log[level]` methods but is otherwise an +`are-we-there-yet` `TrackerGroup` object. + # Events Events are all emitted with the message object. |