consolate v0.2.9

consolate

Customize your Node.JS console like a dignitary.

Easily create intuitive log functions on the console object—even override built-in console functions (error, info, warn, etc.) And while you're at it, feel free to easily define colors, prefixes, and bullets that can automatically animate cli-cursors.

Index

• Examples Super-simple Custom Console Method Overriding Built-in Console Methods Animated vs Static Bullets Smart Log Argument Handling Apollo 11 CI/CD Pipeline Console
• API Reference

Examples

var consolate = require('consolate')

consolate.init({
   arrow: {
      color: consolate.colors.cyan,
      prefix: {
         chars: '>>>>>----->',
         color: consolate.colors.lightCyan
      }
   }
})

console.arrow('My customized "arrow" log method!')

setTimeout(() => {
	console.arrow('Just think of the possibilities :-)')
}, 1500)

setTimeout(() => {
	console.arrow('And we haven\'t even scratched the surface.')
}, 3000)

setTimeout(() => {
	console.arrow('Okay, one more time before moving on.')
	console.log()
}, 4500)

API Reference

consolate.init(options)

The initialization function that must be called to enable consolate.

Kind: static method of consolate

consolate~colors : enum

Color representations of ANSI output text codes that consolate supports.

Kind: inner enum of consolate
Read only: true
Properties

consolate~restore

Restores the console object back to its native state by removing all consolate modifications.

Kind: inner constant of consolate

consolate~consolateOptions : Object

The consolate options object that defines output methods and their respective settings and/or overrides existing log methods and their behavior.

Kind: inner typedef of consolate
Properties

consolate~outputMethodSettings : Object

An object that represents the settings for the output method that has the same name as this object's key.

Kind: inner typedef of consolate
Properties

consolate~prefix : Object

Specifies preferences (if any) for including an automatic prefix to all console output for an output method.

Kind: inner typedef of consolate
Properties

consolate~bullet : Object

Specifies preferences (if any) for including an automatic left-aligned bullet to all console output for an output method.

Kind: inner typedef of consolate
Properties