README
console-ansi
Easy console coloring and prefixing via Proxy object with ANSI strings.
Installation
npm install console-ansi
Usage
import console from "console-ansi";
import styles from "console-ansi/styles.js";
// Set prefix
console.prefix = "[test]";
// Call the console object methods as usual
console.time("Test time");
console.log("Test log");
console.info("Test info");
console.warn("Test warn");
console.error("Test error");
console.timeEnd("Test time");
// Customise color
console.theme.log = styles.blue;
console.log("Test log blue");
// Remove symbols
console.symbol = {};
API
Modules
Typedefs
- ConsoleAnsi :
Object - ConsoleAnsiThemeAttributeArray :
Array.<number> Array for ANSI definition [start, end].
- ConsoleAnsiTheme :
Object.<string, ConsoleAnsiThemeAttributeArray>|Object.<string, Array.<ConsoleAnsiThemeAttributeArray>> Theme object consisting of ANSI styles or Array of ANSI styles.
- ConsoleAnsiLevel :
string Current log level. Can be any console method but levels property only defines log(1)/info(2)/warn(3)/error(4).
- ConsoleAnsiLevels :
Object.<ConsoleAnsiLevel, number> Levels object consisting of console method as keys and numbered priority.
- ConsoleAnsiSymbol :
Object.<string, string> Map of unicode symbols to be prepended to certain console methods.
consoleAnsi
proxiedConsole : ConsoleAnsi ⏏
Export a Proxy object to automatically style the console with ANSI strings.
consoleAnsiStyles
styles : Object.<string, ConsoleAnsiThemeAttributeArray> ⏏
Kind: Exported constant
See
ConsoleAnsi : Object
Kind: global typedef
Properties
| Name | Type | Default | Description |
|---|---|---|---|
| [prefix] | string |
"``" |
A string to prepend to every log. |
| [theme] | ConsoleAnsiTheme |
Color definition associated to console methods. | |
| [level] | ConsoleAnsiLevel |
"log" |
A minimum log level value. See ConsoleAnsiLevels. |
| [levels] | ConsoleAnsiLevels |
{ error: 5, warn: 4, info: 3, log: 2 } |
Numbered priority associated to console methods to match above for level property. |
| [symbol] | ConsoleAnsiSymbol |
{ log: "✔", info: "ℹ", warn: "⚠", error: "✖" } |
Unicode symbols to prepend to defined console methods. |
ConsoleAnsiThemeAttributeArray : Array.<number>
Array for ANSI definition [start, end].
ConsoleAnsiTheme : Object.<string, ConsoleAnsiThemeAttributeArray> | Object.<string, Array.<ConsoleAnsiThemeAttributeArray>>
Theme object consisting of ANSI styles or Array of ANSI styles.
ConsoleAnsiLevel : string
Current log level. Can be any console method but levels property only defines log(1)/info(2)/warn(3)/error(4).
ConsoleAnsiLevels : Object.<ConsoleAnsiLevel, number>
Levels object consisting of console method as keys and numbered priority.
ConsoleAnsiSymbol : Object.<string, string>
Map of unicode symbols to be prepended to certain console methods.
Kind: global typedef
License
MIT. See license file.