trmclr/README.md

trmclr

Easy terminal colors, ported from the Deno standard library.

• Supports Node.js, browsers, Deno, and probably some other environments.
• Comes with 45 colors and helpers.
• Respects NO_COLOR.
• No dependencies.
• Tree-shakeable.

Colors and helpers

bgBlack, bgBlue, bgBrightBlack, bgBrightBlue, bgBrightCyan, bgBrightGreen, bgBrightMagenta, bgBrightRed, bgBrightWhite, bgBrightYellow, bgCyan, bgGreen, bgMagenta, bgRed, bgRgb24, bgRgb8, bgWhite, bgYellow, black, blue, bold, brightBlack, brightBlue, brightCyan, brightGreen, brightMagenta, brightRed, brightWhite, brightYellow, cyan, dim, getColorEnabled, gray, green, hidden, inverse, italic, magenta, red, reset, strikethrough, stripColor, underline, white, yellow

Usage

import { cyan, bgMagenta } from 'trmclr';

console.log(cyan(bgMagenta('Some text')));

Enable or disable color

By using setColorEnabled(true) or setColorEnabled(false) you can respectively enable and disable color output. Use getColorEnabled() to retrieve the current state.

License

(c) 2022-2024 Romein van Buren. Licensed under the MIT license.

For the full copyright and license information, please see the LICENSE.md file that was distributed with this source code.