ansi-styles

property bgBlack

readonly bgBlack: CSPair;

property bgBlackBright

readonly bgBlackBright: CSPair;

property bgBlue

readonly bgBlue: CSPair;

property bgBlueBright

readonly bgBlueBright: CSPair;

property bgCyan

readonly bgCyan: CSPair;

property bgCyanBright

readonly bgCyanBright: CSPair;

property bgGray

readonly bgGray: CSPair;

• Alias for bgBlackBright.

property bgGreen

readonly bgGreen: CSPair;

property bgGreenBright

readonly bgGreenBright: CSPair;

property bgGrey

readonly bgGrey: CSPair;

• Alias for bgBlackBright.

property bgMagenta

readonly bgMagenta: CSPair;

property bgMagentaBright

readonly bgMagentaBright: CSPair;

property bgRed

readonly bgRed: CSPair;

property bgRedBright

readonly bgRedBright: CSPair;

property bgWhite

readonly bgWhite: CSPair;

property bgWhiteBright

readonly bgWhiteBright: CSPair;

property bgYellow

readonly bgYellow: CSPair;

property bgYellowBright

readonly bgYellowBright: CSPair;

property close

readonly close: string;

• The ANSI terminal control sequence for ending this color.

method ansi

ansi: (code: number) => string;

method ansi16m

ansi16m: (red: number, green: number, blue: number) => string;

method ansi256

ansi256: (code: number) => string;

method ansi256ToAnsi

ansi256ToAnsi: (code: number) => number;

• Convert from the ANSI 256 color space to the ANSI 16 color space.

  Parameter code

  A number representing the ANSI 256 color.

method hexToAnsi

hexToAnsi: (hex: string) => number;

• Convert from the RGB HEX color space to the ANSI 16 color space.

  Parameter hex

  A hexadecimal string containing RGB data.

method hexToAnsi256

hexToAnsi256: (hex: string) => number;

• Convert from the RGB HEX color space to the ANSI 256 color space.

  Parameter hex

  A hexadecimal string containing RGB data.

method hexToRgb

hexToRgb: (hex: string) => [red: number, green: number, blue: number];

• Convert from the RGB HEX color space to the RGB color space.

  Parameter hex

  A hexadecimal string containing RGB data.

method rgbToAnsi

rgbToAnsi: (red: number, green: number, blue: number) => number;

• Convert from the RGB color space to the ANSI 16 color space.

  Parameter red

  (0...255)

  Parameter green

  (0...255)

  Parameter blue

  (0...255)

method rgbToAnsi256

rgbToAnsi256: (red: number, green: number, blue: number) => number;

• Convert from the RGB color space to the ANSI 256 color space.

  Parameter red

  (0...255)

  Parameter green

  (0...255)

  Parameter blue

  (0...255)

property close

readonly close: string;

• The ANSI terminal control sequence for ending this style.

property open

readonly open: string;

• The ANSI terminal control sequence for starting this style.

property black

readonly black: CSPair;

property blackBright

readonly blackBright: CSPair;

property blue

readonly blue: CSPair;

property blueBright

readonly blueBright: CSPair;

property cyan

readonly cyan: CSPair;

property cyanBright

readonly cyanBright: CSPair;

property gray

readonly gray: CSPair;

• Alias for blackBright.

property green

readonly green: CSPair;

property greenBright

readonly greenBright: CSPair;

property grey

readonly grey: CSPair;

• Alias for blackBright.

property magenta

readonly magenta: CSPair;

property magentaBright

readonly magentaBright: CSPair;

property red

readonly red: CSPair;

property redBright

readonly redBright: CSPair;

property white

readonly white: CSPair;

property whiteBright

readonly whiteBright: CSPair;

property yellow

readonly yellow: CSPair;

property yellowBright

readonly yellowBright: CSPair;

property bold

readonly bold: CSPair;

• Make text bold.

property dim

readonly dim: CSPair;

• Emitting only a small amount of light.

property hidden

readonly hidden: CSPair;

• Prints the text, but makes it invisible.

property inverse

readonly inverse: CSPair;

• Inverse background and foreground colors.

property italic

readonly italic: CSPair;

• Make text italic. (Not widely supported)

property overline

readonly overline: CSPair;

• Make text overline.

  Supported on VTE-based terminals, the GNOME terminal, mintty, and Git Bash.

property reset

readonly reset: CSPair;

• Resets the current color chain.

property strikethrough

readonly strikethrough: CSPair;

• Puts a horizontal line through the center of the text. (Not widely supported)

property underline

readonly underline: CSPair;

• Make text underline. (Not widely supported)