Class AnsiString

constructor

• new AnsiString(
      indent?: number,
      breaks?: number,
      righty?: boolean,
      defSty?: Style,
  ): AnsiString

  Creates a ANSI string.

  Parameters

  • indent: number = 0

    The starting column for this string (negative values are replaced by zero)
  • breaks: number = 0

    The initial number of line feeds (non-positive values are ignored)
  • righty: boolean = false

    True if the string should be right-aligned to the terminal width
  • defSty: Style = ...

    The default style to use (defaults to none)

  Returns AnsiString

defSty

indent

righty

count

• get count(): number

  Returns number

  The number of internal strings

merge

• set merge(merge: boolean): void

  Sets a flag to merge the next word with the last word.

  Parameters

  • merge: boolean

    The flag value

  Returns void

mergeLeft

• get mergeLeft(): boolean

  Returns boolean

  The mergeLeft flag value

strings

• get strings(): string[]

  Returns string[]

  The list of internal strings without control sequences

styles

• get styles(): string[]

  Returns string[]

  The list of internal strings with control sequences

totalLen

• get totalLen(): number

  Returns number

  The combined length including spaces (but with no wrapping)

add

• add(text: string, styledText: string, close?: boolean): this

  Appends a text.

  Parameters

  • text: string

    The text with no control sequences
  • styledText: string

    The text with possible control sequences
  • close: boolean = false

    True if the text should be merged with the previous string, if any

  Returns this

  The ANSI string instance

break

• break(count?: number): this

  Appends line breaks.

  Parameters

  • count: number = 1

    The number of line breaks to insert (non-positive values are ignored)

  Returns this

  The ANSI string instance

clear

• clear(): this

  Removes all strings.

  Returns this

  The ANSI string instance

close

• close(word: string): this

  Closes with a word.

  Parameters

  • word: string

    The word to insert (should contain no styles)

  Returns this

  The ANSI string instance

closeSty

• closeSty(sty: Style): this

  Closes with a style.

  Parameters

  • sty: Style

    The SGR sequence

  Returns this

  The ANSI string instance

format

• format(phrase: string, flags?: FormattingFlags, ...args: Args): this

  Formats a text from a custom phrase with a set of arguments.

  Parameters

  • phrase: string

    The message phrase
  • flags: FormattingFlags = {}

    The formatting flags
  • ...args: Args

    The message arguments

  Returns this

  The ANSI string instance

open

• open(word: string): this

  Opens with a word.

  Parameters

  • word: string

    The word to insert (should contain no styles)

  Returns this

  The ANSI string instance

openAtPos

• openAtPos(text: string, pos: number): this

  Prepends text to the string at a specific position. This can only be done if the affected string does not contain opening styles.

  Parameters

  • text: string

    The opening text
  • pos: number

    The position of the previously added string

  Returns this

  The ANSI string instance

openSty

• openSty(sty: Style): this

  Opens with a style.

  Parameters

  • sty: Style

    The SGR sequence

  Returns this

  The ANSI string instance

other

• other(other: AnsiString): this

  Appends another ANSI string.

  Parameters

  • other: AnsiString

    The other ANSI string

  Returns this

  The ANSI string instance

split

• split(text: string, format?: FormatCallback<string>): this

  Splits a text into words and style sequences, and appends them.

  Parameters

  • text: string

    The text to be split
  • Optionalformat: FormatCallback<string>

    An optional callback to process placeholders

  Returns this

  The ANSI string instance

word

• word(word: string, sty?: Style): this

  Appends a word.

  Parameters

  • word: string

    The word to insert (should contain no styles)
  • Optionalsty: Style

    The style to be applied

  Returns this

  The ANSI string instance

wrap

• wrap(
      result: string[],
      column: number,
      width: number,
      emitStyles: boolean,
      emitSpaces: boolean,
  ): number

  Wraps the internal strings to fit in a terminal width.

  Parameters

  • result: string[]

    The resulting strings to append to
  • column: number

    The current terminal column
  • width: number

    The desired terminal width (or zero to avoid wrapping)
  • emitStyles: boolean

    True if styles should be emitted
  • emitSpaces: boolean

    True if spaces should be emitted instead of move sequences

  Returns number

  The updated terminal column