npmlog

npmlog

La utilidad de registro que utiliza npm.

Este registrador es muy básico. Realiza el registro para npm. Admite niveles personalizados y salida en color.

De forma predeterminada, los registros se escriben en stderr. Si desea enviar mensajes de registro a salidas que no sean transmisiones, puede cambiar el miembro log.stream o simplemente escuchar los eventos que emite y hacer lo que quiera con ellos.

Instalación

 npm install npmlog --save

Uso básico

 var log = require ( 'npmlog' )

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

nivel.de.log

• {Cadena}

El nivel en el que mostrar los registros. Se mostrarán todos los registros en o por encima de este nivel. El nivel especial de silent evitará que se muestre nada.

registro.registro

• {Formación}

Una matriz de todos los mensajes de registro que se han ingresado.

log.maxRecordSize

• {Número}

El número máximo de registros que se deben conservar. Si log.record supera el 10 % de este valor, se reduce al 90 % de este valor.

El motivo de la ventana del 10% es para no tener que cambiar el tamaño de una matriz grande en cada entrada del registro.

log.prefixStyle

• {Objeto}

Un objeto de estilo que especifica cómo se diseñan los prefijos. (Vea abajo)

log.headingStyle

• {Objeto}

Un objeto de estilo que especifica cómo se aplica el estilo al título. (Vea abajo)

encabezado de registro

• {Cadena} Predeterminado: ""

Si se establece, un encabezado que se imprime al comienzo de cada línea.

registro.stream

• {Transmisión} Predeterminado: process.stderr

La secuencia donde se escribe la salida.

log.enableColor()

Fuerza el uso de colores en todos los mensajes, independientemente del flujo de salida.

log.disableColor()

Desactiva los colores en todos los mensajes.

log.enableProgress()

Habilitar la visualización del control giratorio de actividad del registro y la barra de progreso

log.disableProgress()

Deshabilitar la visualización de una barra de progreso

log.enableUnicode()

Fuerza el uso del tema Unicode para la barra de progreso.

log.disableUnicode()

Deshabilite el uso de Unicode en la barra de progreso.

log.setGaugeTemplate(plantilla)

Establezca una plantilla para generar la barra de progreso. Consulte la documentación del medidor para obtener más detalles.

log.setGaugeThemeset(temas)

Seleccione un conjunto de temas para elegir temas para la barra de progreso. Consulte la documentación del medidor para obtener más detalles.

registro.pausa()

Deja de emitir mensajes a la transmisión, pero no los descartes.

registro.reanudar()

Emite todos los mensajes almacenados en el búfer que se escribieron mientras estaba en pausa.

log.log(nivel, prefijo, mensaje, ...)

• level {String} El nivel para emitir el mensaje en
• prefix {String} Un prefijo de cadena. Establezca "" para omitir.
• message... Argumentos para util.format

Emitir un mensaje de registro en el nivel especificado.

log[nivel](prefijo, mensaje, ...)

Por ejemplo,

• log.silly(prefijo, mensaje, ...)
• log.verbose(prefijo, mensaje, ...)
• log.info(prefijo, mensaje, ...)
• log.http(prefijo, mensaje, ...)
• log.warn(prefijo, mensaje, ...)
• log.error(prefijo, mensaje, ...)

Como log.log(level, prefix, message, ...) . De esta manera, cada nivel recibe una taquigrafía, por lo que puede hacerlo log.info(prefix, message) .

log.addLevel(nivel, n, estilo, disp)

• level {String} Indicador de nivel
• n {Número} El nivel numérico
• style {Objeto} Objeto con fg, bg, inverso, etc.
• disp {String} Reemplazo opcional para level en la salida.

Configura un nuevo nivel con una función taquigráfica, etc.

Tenga en cuenta que si el número es Infinity , establecer el nivel en ese nivel hará que se supriman todos los mensajes de registro. Si el número es -Infinity , entonces la única forma de mostrarlo es habilitar todos los mensajes de registro.

log.newItem(nombre, tareas pendientes, peso)

• name {Cadena} Opcional; nombre del elemento de progreso.
• todo {Número} Opcional; cantidad total de trabajo a realizar. Predeterminado 0.
• weight {Número} Opcional; el peso de este artículo en relación con otros. Predeterminado 1.

Esto agrega un nuevo rastreador de elementos are-we-there-yet al rastreador de progreso. El objeto devuelto tiene los métodos log[level] pero, por lo demás, es un objeto Tracker are-we-there-yet .

log.newStream(nombre, tarea, peso)

Esto agrega un nuevo rastreador de transmisiones are-we-there-yet al rastreador de progreso. El objeto devuelto tiene los métodos log[level] pero, por lo demás, es un objeto TrackerStream are-we-there-yet .

log.newGroup(nombre, peso)

Esto agrega un nuevo grupo de seguimiento are-we-there-yet al seguimiento de progreso. El objeto devuelto tiene los métodos log[level] pero, por lo demás, es un objeto TrackerGroup are-we-there-yet .

Eventos

Todos los eventos se emiten con el objeto de mensaje.

• log Emitido para todos los mensajes
• log. Emitido para todos los mensajes con el nivel .
• Los mensajes con prefijos también emiten su prefijo como evento.

Objetos de estilo

Los objetos de estilo pueden tener los siguientes campos:

• fg {String} Color del texto de primer plano
• bg {String} Color del fondo
• bold , inverse , underline {Booleano} Establece la propiedad asociada
• bell {Boolean} Haz un ruido (Esto probablemente sea bastante molesto).

Objetos de mensaje

Cada evento de registro se emite con un objeto de mensaje y la lista log.record contiene todos los que se han creado. Tienen los siguientes campos:

• id {Número}
• level {Cadena}
• prefix {Cadena}
• message {Cadena} Resultado de util.format()
• messageRaw {Array} Argumentos para util.format()

Bloqueo de TTY

Usamos set-blocking para configurar el bloqueo stderr y stdout si son tty y tienen la llamada setBlocking. Esta es una solución alternativa a un problema en las primeras versiones de Node.js 6.x, que hacía que stderr y stdout no bloquearan en OSX. (Siempre están bloqueando Windows y nunca bloquearon en Linux). npmlog necesita que estén bloqueando para poder permitir que la salida stdout y stderr se entrelazan.