Class TerminalString

constructor

• new TerminalString(indent?, breaks?, rightAlign?): TerminalString

• Creates a terminal 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)
  • rightAlign: boolean = false

    True if the string should be right-aligned to the terminal width

  Returns TerminalString

indent

count

• get count(): number

• Returns number

  The number of internal strings

lengths

• get lengths(): number[]

• Returns number[]

  The lengths of internal strings

strings

• get strings(): string[]

• Returns string[]

  The list of internal strings

add

• add(text, length): this

• Appends a text that may contain control characters or sequences to the list.

  Parameters

  • text: string

    The text to be appended
  • length: number

    The length of the text without control characters or sequences

  Returns this

  The terminal string instance

break

• break(count?): this

• Appends line breaks to the list.

  Parameters

  • count: number = 1

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

  Returns this

  The terminal string instance

clear

• clear(): this

• Appends an SGR clear sequence to the list. This is different from the pop method (we are aware of this ambiguity, but we want method names to be short).

  Returns this

  The terminal string instance

close

• close(word): this

• Appends a word that is merged with the last word.

  Parameters

  • word: string

    The closing word

  Returns this

  The terminal string instance

format

• format(styles, phrase, args?, flags?): this

• Formats a set of arguments.

  Parameters

  • styles: FormatStyles

    The format styles
  • phrase: string

    The custom phrase
  • Optional args: FormatArgs

    The format arguments
  • Optional flags: FormattingFlags

    The formatting flags

  Returns this

  The terminal string instance

open

• open(word, pos?): this

• Appends a word that will be merged with the next word.

  Parameters

  • word: string

    The opening word
  • pos: number = NaN

    The position of a previously added word

  Returns this

  The terminal string instance

other

• other(other): this

• Appends another terminal string to the list. We deliberately avoided optimizing this code, in order to keep it short.

  Parameters

  • other: TerminalString

    The other terminal string

  Returns this

  The terminal string instance

pop

• pop(count?): this

• Removes strings from the end of the list.

  Parameters

  • count: number = 1

    The number of strings

  Returns this

  The terminal string instance

seq

• seq(seq): this

• Appends a sequence to the list.

  Parameters

  • seq: Sequence

    The sequence to insert

  Returns this

  The terminal string instance

setMerge

• setMerge(merge?): this

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

  Parameters

  • merge: boolean = true

    The flag value (defaults to true)

  Returns this

  The terminal string instance

split

• split(text, format?): this

• Splits a text into words and style sequences, and appends them to the list.

  Parameters

  • text: string

    The text to be split
  • Optional format: FormatCallback<string>

    An optional callback to process format specifiers

  Returns this

  The terminal string instance

style

• style(begin, word, end?): this

• Appends a word with surrounding styles.

  Parameters

  • begin: Style

    The starting style
  • word: string

    The word to be appended
  • end: Style = ''

    The ending style (optional)

  Returns this

  The terminal string instance

word

• word(word): this

• Appends a word to the list.

  Parameters

  • word: string

    The word to be appended. Should not contain control characters or sequences.

  Returns this

  The terminal string instance

wrap

• wrap(result, column, width, emitStyles): 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

  Returns number

  The updated terminal column