Get Started

1. Install the module by using npm i @hitomihiumi/colors.ts
2. Enjoy!

Colors

text colors

• black
• red
• green
• yellow
• blue
• magenta
• cyan
• white
• gray
• grey

bright text colors

• brightRed
• brightGreen
• brightYellow
• brightBlue
• brightMagenta
• brightCyan
• brightWhite

background colors

• bgBlack
• bgRed
• bgGreen
• bgYellow
• bgBlue
• bgMagenta
• bgCyan
• bgWhite
• bgGray
• bgGrey

bright background colors

• bgBrightRed
• bgBrightGreen
• bgBrightYellow
• bgBrightBlue
• bgBrightMagenta
• bgBrightCyan
• bgBrightWhite

styles

• reset
• bold
• dim
• italic
• underline
• inverse
• hidden
• strikethrough

extras

• rainbow
• zebra
• america
• trap
• random

Usage

1import '@hitomihiumi/colors.ts';
2
3console.log('hello'.green); // outputs green text
4console.log('i like cake and pies'.underline.red); // outputs red underlined text
5console.log('inverse the color'.inverse); // inverses the color
6console.log('OMG Rainbows!'.rainbow); // rainbow
7console.log('Run the trap'.trap); // Drops the bass

Important Notes

Specify the bold argument only after all style labels, otherwise you will get an error (applies to TS only)

1console.log('hello'.green.bold);

Enabling/Disabling Colors

The package will auto-detect whether your terminal can use colors and enable/disable accordingly. When colors are disabled, the color functions do nothing. You can override this with a command-line flag:

1node myapp.js --no-color
2node myapp.js --color=false
3
4node myapp.js --color
5node myapp.js --color=true
6node myapp.js --color=always
7
8FORCE_COLOR=1 node myapp.js

Or in code:

1import { colors } from '@hitomihiumi/colors.ts';
2
3colors.enable();
4colors.disable();

Custom themes

Using standard API

1import { colors } from '@hitomihiumi/colors.ts';
2
3colors.setTheme({
4  silly: 'rainbow',
5  input: 'grey',
6  verbose: 'cyan',
7  prompt: 'grey',
8  info: 'green',
9  data: 'grey',
10  help: 'cyan',
11  warn: 'yellow',
12  debug: 'blue',
13  error: 'red'
14});
15
16declare global {
17  interface String {
18    silly: string;
19    input: string;
20    verbose: string;
21    prompt: string;
22    info: string;
23    data: string;
24    help: string;
25    warn: string;
26    debug: string;
27    error: string;
28  }
29}
30
31// outputs red text
32console.log("this is an error".error);
33
34// outputs yellow text
35console.log("this is a warning".warn);

Combining Colors

1import { colors } from '@hitomihiumi/colors.ts';
2
3colors.setTheme({
4  custom: ['red', 'underline']
5});
6
7declare global {
8    interface String {
9        custom: string;
10    }
11}
12
13console.log('test'.custom);