another-ansi's Introduction

another-ansi

Install

npm install another-ansi

Usage

import { AnotherAnsiProvider, ColorType } from 'another-ansi';

const p = new AnotherAnsiProvider();

// red text color
console.log(p.color(ColorType.Red, 'test'));

// red text color + green background color
console.log(p.bgColor(ColorType.Green, p.color(ColorType.Red, 'test')));

// red text color via hex
console.log(p.colorWithHex('#FF0000', 'test'));

// red text color via rgb
console.log(p.colorWithRgb(255, 0, 0, 'test'));

// bold text
console.log(p.modify(ModifierType.Bold, 'test'));

// clear console - only osx
console.log(p.command(CommandType.Clear));

Escape sequences

EscapeSequence.Unicode // '\u001B' by default
EscapeSequence.Hex // '\x1b'

Can be used to define escape sequence in ansi provider:

const p  = new AnotherAnsiProvider(EscapeSequence.Hex);
p.color(ColorType.Red, 'test'); // \x1b[31mtest\x1b[39m

Modifier + Colors

Modifier:

enum ModifierType {
  Reset,
  Bold,
  Dim,
  Italic,
  Underline,
  Overline,
  Inverse,
  Hidden,
  Strikethrough
}

Colors:

enum ColorType {
  Black,
  Red,
  Green,
  Yellow,
  Blue,
  Magenta,
  Cyan,
  White,
  BlackBright,
  Gray,
  Grey,
  RedBright,
  GreenBright,
  YellowBright,
  BlueBright,
  MagentaBright,
  CyanBright,
  WhiteBright
}

Commands:

enum CommandType {
  Clear
}

Style Object

const styleObject = provider.getStyleObject();

// red text color
console.log(`${styleObject.color.red.open}test${styleObject.color.close}`);

// red background color
console.log(`${styleObject.bgColor.red.open}test${styleObject.bgColor.close}`);

// red background color
console.log(`${styleObject.bgColorBy16m(255, 0, 0)}test${styleObject.bgColor.close}`);

Recommend Projects