npm日志

npm日志

npm 使用的记录器 util。

这个记录器非常基本。它为 npm 进行日志记录。它支持自定义级别和彩色输出。

默认情况下，日志写入 stderr。如果您想将日志消息发送到流以外的输出，那么您可以更改log.stream成员，或者您可以只侦听它发出的事件，并对它们执行任何您想要的操作。

安装

 npm install npmlog --save

基本用法

 var log = require ( 'npmlog' )

// additional stuff ---------------------------+
// message ----------+                         |
// prefix ----+      |                         |
// level -+   |      |                         |
//        v   v      v                         v
    log . info ( 'fyi' , 'I have a kitty cat: %j' , myKittyCat ) 

日志级别

• {细绳}

显示日志的级别。任何处于或高于此级别的日志都会显示。特殊级别的silent将阻止任何内容显示。

日志记录

• {大批}

已输入的所有日志消息的数组。

log.maxRecordSize

• {数字}

要保留的最大记录数。如果 log.record 超过该值的 10%，则它会被分割为该值的 90%。

10% 窗口的原因是它不必在每个日志条目上调整大型数组的大小。

log.prefixStyle

• {目的}

指定前缀样式的样式对象。 （见下文）

log.headingStyle

• {目的}

指定标题样式的样式对象。 （见下文）

日志标题

• {String} 默认值：“”

如果设置，则在每行开头打印标题。

日志流

• {Stream} 默认： process.stderr

写入输出的流。

log.enableColor()

强制在所有消息上使用颜色，无论输出流如何。

log.disableColor()

禁用所有消息的颜色。

log.enableProgress()

启用日志活动微调器和进度条的显示

log.disableProgress()

禁用进度条的显示

log.enableUnicode()

强制进度条使用 unicode 主题。

log.disableUnicode()

禁止在进度条中使用 unicode。

log.setGaugeTemplate(模板)

设置输出进度条的模板。有关详细信息，请参阅仪表文档。

log.setGaugeThemeset(主题)

选择一个主题集以从中挑选进度条的主题。有关详细信息，请参阅仪表文档。

日志.pause()

停止向流发送消息，但不要丢弃它们。

日志.resume()

发出暂停时写入的所有缓冲消息。

log.log(级别、前缀、消息、...)

• level {String} 发出消息的级别
• prefix {String} 字符串前缀。设置为“”以跳过。
• message... util.format的参数

在指定级别发出日志消息。

日志[级别]（前缀，消息，...）

例如，

• log.silly（前缀，消息，...）
• log.verbose（前缀，消息，...）
• log.info(前缀、消息、...)
• log.http（前缀，消息，...）
• log.warn（前缀，消息，...）
• log.error（前缀，消息，...）

像log.log(level, prefix, message, ...) 。这样，每个级别都会有一个简写，因此您可以执行log.info(prefix, message) 。

log.addLevel（级别，n，样式，显示）

• level {String} 级别指示器
• n {Number} 数字级别
• style {Object} 具有 fg、bg、inverse 等的对象。
• disp {String} 输出中level的可选替换。

使用速记功能等设置新级别。

请注意，如果数字为Infinity ，则将级别设置为该值将导致所有日志消息被抑制。如果数字是-Infinity ，那么显示它的唯一方法是启用所有日志消息。

log.newItem(名称、待办事项、重量)

• name {String} 可选；进度项名称。
• todo {Number} 可选；需要完成的工作总量。默认 0。
• weight {Number} 可选；该物品相对于其他物品的重量。默认 1。

这会向进度跟踪器添加一个新的are-we-there-yet项目跟踪器。返回的对象具有log[level]方法，但在其他方面是一个are-we-there-yet Tracker对象。

log.newStream(名称、待办事项、权重)

这会向进度跟踪器添加一个新的are-we-there-yet流跟踪器。返回的对象具有log[level]方法，但在其他方面是一个are-we-there-yet TrackerStream对象。

log.newGroup(名称, 权重)

这会向进度跟踪器添加一个新的are-we-there-yet跟踪器组。返回的对象具有log[level]方法，但在其他方面是一个are-we-there-yet TrackerGroup对象。

活动

事件都是通过消息对象发出的。

• 为所有消息发出log
• log.为具有级别的所有消息发出。
• 带有前缀的消息也会将其前缀作为事件发出。

样式对象

样式对象可以具有以下字段：

• fg {String} 前景文本的颜色
• bg {String} 背景颜色
• bold , inverse , underline {Boolean} 设置关联属性
• bell {Boolean} 发出声音（这可能很烦人。）

消息对象

每个日志事件都会发出一个消息对象， log.record列表包含所有已创建的事件。他们有以下字段：

• id {数字}
• level {字符串}
• prefix {字符串}
• message {String} util.format()的结果
• messageRaw {Array} util.format()的参数

阻止 TTY

我们使用set-blocking来设置 stderr 和 stdout 阻塞（如果它们是 tty 的并且有 setBlocking 调用）。这是针对 Node.js 6.x 早期版本中的一个问题的解决方案，该问题导致 OSX 上的 stderr 和 stdout 非阻塞。 （它们总是阻塞 Windows，而在 Linux 上从不阻塞。） npmlog需要它们阻塞，以便它可以允许输出到 stdout 和 stderr 进行交错。