roundel
API reference

roundel/colorette

Every export of roundel/colorette, with its signature and doc comment: createColors, isColorSupported, reset, bold, dim, italic and 37 more, plus 2 types.

import { createColors, isColorSupported, reset, … } from 'roundel/colorette';

Functions

createColors

The styles, coloured or not. useColor defaults to {@link isColorSupported}.

function createColors({ useColor }?: {
    useColor?: boolean;
}): Colorette;
ParameterType
{ useColor } (optional){ useColor?: boolean; }

Returns Colorette

Constants

bgBlack

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgBlackBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgBlue

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgBlueBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgCyan

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgCyanBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgGreen

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgGreenBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgMagenta

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgMagentaBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgRed

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgRedBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgWhite

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgWhiteBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgYellow

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bgYellowBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

black

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

blackBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

blue

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

blueBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

bold

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

cyan

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

cyanBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

dim

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

gray

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

green

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

greenBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

hidden

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

inverse

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

isColorSupported

Whether colorette would colour this process's output.

const isColorSupported: boolean;

italic

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

magenta

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

magentaBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

red

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

redBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

reset

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

strikethrough

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

underline

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

white

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

whiteBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

yellow

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

yellowBright

const reset: Color, bold: Color, dim: Color, italic: Color, underline: Color, inverse: Color, hidden: Color, strikethrough: Color, black: Color, red: Color, green: Color, yellow: Color, blue: Color, magenta: Color, cyan: Color, white: Color, gray: Color, bgBlack: Color, bgRed: Color, bgGreen: Color, bgYellow: Color, bgBlue: Color, bgMagenta: Color, bgCyan: Color, bgWhite: Color, blackBright: Color, redBright: Color, greenBright: Color, yellowBright: Color, blueBright: Color, magentaBright: Color, cyanBright: Color, whiteBright: Color, bgBlackBright: Color, bgRedBright: Color, bgGreenBright: Color, bgYellowBright: Color, bgBlueBright: Color, bgMagentaBright: Color, bgCyanBright: Color, bgWhiteBright: Color;

Interfaces

Colorette

Every style, by colorette's names: what createColors returns.

interface Colorette {
    reset: Color;
    bold: Color;
    dim: Color;
    italic: Color;
    underline: Color;
    inverse: Color;
    hidden: Color;
    strikethrough: Color;
    black: Color;
    red: Color;
    green: Color;
    yellow: Color;
    blue: Color;
    magenta: Color;
    cyan: Color;
    white: Color;
    gray: Color;
    bgBlack: Color;
    bgRed: Color;
    bgGreen: Color;
    bgYellow: Color;
    bgBlue: Color;
    bgMagenta: Color;
    bgCyan: Color;
    bgWhite: Color;
    blackBright: Color;
    redBright: Color;
    greenBright: Color;
    yellowBright: Color;
    blueBright: Color;
    magentaBright: Color;
    cyanBright: Color;
    whiteBright: Color;
    bgBlackBright: Color;
    bgRedBright: Color;
    bgGreenBright: Color;
    bgYellowBright: Color;
    bgBlueBright: Color;
    bgMagentaBright: Color;
    bgCyanBright: Color;
    bgWhiteBright: Color;
}

Types

Color

One style: the text between an open and a close code.

type Color = (text: string | number) => string;

On this page