Class Ansi

constructor

• new Ansi(options: Partial<AnsiOptions>, ...parts: AnsiPart[]): Ansi

  Creates a new instance.

  Parameters

  • options: Partial<AnsiOptions>

    Styling options to apply to the contents.
  • ...parts: AnsiPart[]

    Parts that make up the styled output.

  Returns Ansi

Readonlyoptions

Readonlyparts

Static ReadonlydefaultOptions

Static ReadonlyINTENSE_BLACK

Static ReadonlyINTENSE_BLUE

Static ReadonlyINTENSE_CYAN

Static ReadonlyINTENSE_GREEN

Static ReadonlyINTENSE_MAGENTA

Static ReadonlyINTENSE_RED

Static ReadonlyINTENSE_WHITE

Static ReadonlyINTENSE_YELLOW

Static ReadonlySTANDARD_BLACK

Static ReadonlySTANDARD_BLUE

Static ReadonlySTANDARD_CYAN

Static ReadonlySTANDARD_GREEN

Static ReadonlySTANDARD_MAGENTA

Static ReadonlySTANDARD_RED

Static ReadonlySTANDARD_WHITE

Static ReadonlySTANDARD_YELLOW

toString

• toString(resolvedOuterOptions?: AnsiOptions): string

  Renders this instance and all nested parts to a string.

  Parameters

  • resolvedOuterOptions: AnsiOptions = Ansi.defaultOptions

    Active options of the parent context.

  Returns string

StaticBASIC_RGB

• BASIC_RGB(r: number, g: number, b: number): AnsiColor

  Parameters

  • r: number

    Red component (0-5)
  • g: number

    Green component (0-5)
  • b: number

    Blue component (0-5)

  Returns AnsiColor

  Ansi color code

StaticGRAYSCALE

• GRAYSCALE(n: number): AnsiColor

  Parameters

  • n: number

    Grayscale level (0-23)

  Returns AnsiColor

  Ansi color code

StaticTRUE_COLOR

• TRUE_COLOR(r: number, g: number, b: number): AnsiColor

  Creates a 24 bit true color value.

  Parameters

  • r: number

    Red component (0-255)
  • g: number

    Green component (0-255)
  • b: number

    Blue component (0-255)

  Returns AnsiColor

Statictt

• tt(oprions: Partial<AnsiOptions>): AnsiTemplateTag

  Returns a template tag preconfigured with the provided options.

  Parameters

  • oprions: Partial<AnsiOptions>

  Returns AnsiTemplateTag