https://github.com/dmnsgn/console-ansi
Easy console coloring and prefixing via Proxy object with ANSI strings.
https://github.com/dmnsgn/console-ansi
ansi ansi-colors chalk colors console prefix proxy symbol theme
Last synced: 5 months ago
JSON representation
Easy console coloring and prefixing via Proxy object with ANSI strings.
- Host: GitHub
- URL: https://github.com/dmnsgn/console-ansi
- Owner: dmnsgn
- License: mit
- Created: 2021-03-22T22:25:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-06T13:30:29.000Z (about 1 year ago)
- Last Synced: 2025-04-15T21:22:11.380Z (6 months ago)
- Topics: ansi, ansi-colors, chalk, colors, console, prefix, proxy, symbol, theme
- Language: JavaScript
- Homepage:
- Size: 859 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# console-ansi
[](https://www.npmjs.com/package/console-ansi)
[](https://www.npmjs.com/package/console-ansi)
[](https://bundlephobia.com/package/console-ansi)
[](https://github.com/dmnsgn/console-ansi/blob/main/package.json)
[](https://github.com/microsoft/TypeScript)
[](https://conventionalcommits.org)
[](https://github.com/prettier/prettier)
[](https://github.com/eslint/eslint)
[](https://github.com/dmnsgn/console-ansi/blob/main/LICENSE.md)
Easy console coloring and prefixing via Proxy object with ANSI strings. Works in Node.js and in browsers that support ANSI strings.
[](https://paypal.me/dmnsgn)
[](https://commerce.coinbase.com/checkout/56cbdf28-e323-48d8-9c98-7019e72c97f3)
[](https://twitter.com/dmnsgn)
## Installation
```bash
npm install console-ansi
```
## Usage
```js
import console, { styles } from "console-ansi";
// 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.
## console-ansi
- [console-ansi](#module_console-ansi)
- [.styles](#module_console-ansi.styles) : [ConsoleAnsiTheme](#ConsoleAnsiTheme)
- [.default](#module_console-ansi.default) : [ConsoleAnsi](#ConsoleAnsi)
- [.getConsole(options)](#module_console-ansi.getConsole) ⇒ [ConsoleAnsi](#ConsoleAnsi)
### console-ansi.styles : [ConsoleAnsiTheme](#ConsoleAnsiTheme)
Basic ANSI escape codes map
**Kind**: static property of [console-ansi](#module_console-ansi)
**See**
- [Wikipedia ANSI]()
- [Node.js util](https://nodejs.org/api/util.html#util_customizing_util_inspect_colors)
### console-ansi.default : [ConsoleAnsi](#ConsoleAnsi)
Export a Proxy object to automatically style the console with ANSI strings.
**Kind**: static property of [console-ansi](#module_console-ansi)
### console-ansi.getConsole(options) ⇒ [ConsoleAnsi](#ConsoleAnsi)
Get an instance of the Proxy-ed console. Useful if you need different prefixes for instance.
**Kind**: static method of [console-ansi](#module_console-ansi)
| Param | Type |
| ------- | ---------------------------------------- |
| options | [ConsoleAnsi](#ConsoleAnsi) |
## ConsoleAnsi : object
**Kind**: global typedef
**Properties**
| Name | Type | Default | Description |
| --------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- |
| [prefix] | string | "\"\"" | A string to prepend to every log. |
| [theme] | [ConsoleAnsiTheme](#ConsoleAnsiTheme) | | Color definition associated to console methods. |
| [level] | [ConsoleAnsiLevel](#ConsoleAnsiLevel) | "log" | A minimum log level value. See ConsoleAnsiLevels. |
| [levels] | [ConsoleAnsiLevels](#ConsoleAnsiLevels) | { error: 5, warn: 4, info: 3, log: 2 } | Numbered priority associated to console methods to match above for level property. |
| [symbol] | [ConsoleAnsiSymbol](#ConsoleAnsiSymbol) | { log: "✔", info: "ℹ", warn: "⚠", error: "✖" } | Unicode symbols to prepend to defined console methods. |
| [noColor] | boolean | false | Disable color ansi sequence. |
## 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](https://github.com/dmnsgn/console-ansi/blob/main/LICENSE.md).