Class DefaultPrinterService

constructor

• new DefaultPrinterService(
      stdoutWritableStream: WritableStream,
      stderrWritableStream: WritableStream,
      stdoutIsColor: boolean,
      stderrIsColor: boolean,
      stdoutTerminal: Terminal,
      stderrTerminal: Terminal,
      styler: Styler,
  ): DefaultPrinterService

  Parameters

  • stdoutWritableStream: WritableStream
  • stderrWritableStream: WritableStream
  • stdoutIsColor: boolean
  • stderrIsColor: boolean
  • stdoutTerminal: Terminal
  • stderrTerminal: Terminal
  • styler: Styler

  Returns DefaultPrinterService

ReadonlystderrWritable

ReadonlystdoutWritable

colorEnabled

• get colorEnabled(): boolean

  Disable or enable color output for messages.

  Returns boolean

• set colorEnabled(enabled: boolean): void

  Disable or enable color output for messages.

  Parameters

  • enabled: boolean

  Returns void

darkMode

• get darkMode(): boolean

  Enable or disable dark mode. Default is disabled i.e. false.

  Returns boolean

• set darkMode(isDarkMode: boolean): void

  Enable or disable dark mode. Default is disabled i.e. false.

  Parameters

  • isDarkMode: boolean

  Returns void

hyperlinksEnabled

• get hyperlinksEnabled(): boolean

  Disable or enable hyperlink output for messages.

  Returns boolean

• set hyperlinksEnabled(enabled: boolean): void

  Disable or enable hyperlink output for messages.

  Parameters

  • enabled: boolean

  Returns void

backgroundBlue

• backgroundBlue(message: string): string

  Return the provided message so that the background is blue. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

backgroundColor

• backgroundColor(message: string, hexFormattedColor: string): string

  Return the provided message so that the background is the specified color. Has no effect if colorEnabled is false.

  Parameters

  • message: string

    the message to color.

  • hexFormattedColor: string

    the color to use. This should be a valid hex formatted string e.g. "#rrggbb".

  Returns string

backgroundCyan

• backgroundCyan(message: string): string

  Return the provided message so that the background is cyan. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

backgroundEmphasised

• backgroundEmphasised(message: string): string

  Return the provided message so that the background is colored as emphasised content. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

backgroundGreen

• backgroundGreen(message: string): string

  Return the provided message so that the background is green. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

backgroundMagenta

• backgroundMagenta(message: string): string

  Return the provided message so that the background is magenta. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

backgroundOrange

• backgroundOrange(message: string): string

  Return the provided message so that the background is orange. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

backgroundPrimary

• backgroundPrimary(message: string): string

  Return the provided message so that the background is colored as primary content. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

backgroundRed

• backgroundRed(message: string): string

  Return the provided message so that the background is red. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

backgroundSecondary

• backgroundSecondary(message: string): string

  Return the provided message so that the background is colored as secondary content. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

backgroundSelected

• backgroundSelected(message: string): string

  Return the provided message so that the background is colored as selected content. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

backgroundViolet

• backgroundViolet(message: string): string

  Return the provided message so that the background is violet. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

backgroundYellow

• backgroundYellow(message: string): string

  Return the provided message so that the background is yellow. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

blue

• blue(message: string): string

  Return the provided message so that the foreground is blue. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

clearMarked

• clearMarked(minimumDisplayTimeMs?: number): Promise<void>

  Erase the terminal rows tracked since the last startMark/endMark pair, moving any following content up.

  Parameters

  • minimumDisplayTimeMs: number = 0

    optional minimum time (in milliseconds) that must have elapsed since endMark was called before the rows are erased; if less time has elapsed, waits for the remainder before clearing. Defaults to 0.

    Throws if called without a preceding endMark.

  Returns Promise<void>

color

• color(message: string, hexFormattedColor: string): string

  Return the provided message so that the foreground is the specified color. Has no effect if colorEnabled is false.

  Parameters

  • message: string

    the message to color.

  • hexFormattedColor: string

    the color to use. This should be a valid hex formatted string e.g. "#rrggbb".

  Returns string

cyan

• cyan(message: string): string

  Return the provided message so that the foreground is cyan. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

debug

• debug(message: string, icon?: Icon): Promise<void>

  Print a Level.DEBUG level message on stderr. Will be displayed as secondary content if colorEnabled is true.

  Parameters

  • message: string

    the message to output.

  • Optionalicon: Icon

    optional icon to display with the message.

  Returns Promise<void>

discardMark

• discardMark(): void

  Stop tracking rows for the current mark region without erasing them - e.g. when the marked output should be left on screen (such as a spawned command's output on failure), but the mark/quote bookkeeping still needs to be reset so a later startMark() doesn't throw.

  Returns void

emphasised

• emphasised(message: string): string

  Return the provided message so that the foreground is colored as emphasised content. The actual color will depend on the value of darkMode. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

endMark

• endMark(): void

  Stop tracking rows for the current mark region (see startMark). The tracked row count is frozen; further writes are not counted. Use clearMarked to erase the tracked rows.

  Throws if called without a matching startMark.

  Returns void

endQuote

• endQuote(): void

  End the most recently started quote level (see startQuote).

  Throws if called without a matching startQuote.

  Returns void

error

• error(message: string, icon?: Icon): Promise<void>

  Print an Level.ERROR level message on stderr. Will be displayed as red content if colorEnabled is true.

  Parameters

  • message: string

    the message to output.

  • Optionalicon: Icon

    optional icon to display with the message.

  Returns Promise<void>

getLevel

• getLevel(): Level

  Get the output threshold Level for stderr.

  Returns Level

green

• green(message: string): string

  Return the provided message so that the foreground is green. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

hideAllProgressBars

• hideAllProgressBars(): Promise<void>

  Hides all progress bars.

  NOTE: Showing the spinner will also hide ALL progress bars.

  Returns Promise<void>

hideProgressBar

• hideProgressBar(handle: number): Promise<void>

  Hides a specified progress bar.

  NOTE: Showing the spinner will also hide ALL progress bars.

  Parameters

  • handle: number

    the handle referring to the progress bar to be hidden.

  Returns Promise<void>

hideSpinner

• hideSpinner(): Promise<void>

  Hide the spinner.

  NOTE: Showing a progress bar will also hide the spinner.

  Returns Promise<void>

hyperlink

• hyperlink(text: string, url: string): string

  Return the provided text wrapped in an OSC 8 hyperlink to the specified URL. Has no effect if hyperlinksEnabled is false, in which case the text is returned unchanged.

  Parameters

  • text: string

    the text to display as the hyperlink.

  • url: string

    the URL target of the hyperlink.

  Returns string

info

• info(message: string, icon?: Icon): Promise<void>

  Print an Level.INFO level message on stderr. Will be displayed as primary content if colorEnabled is true.

  Parameters

  • message: string

    the message to output.

  • Optionalicon: Icon

    optional icon to display with the message.

  Returns Promise<void>

italic

• italic(message: string): string

  Return the provided message so that the text is displayed in italic.

  Parameters

  • message: string

  Returns string

magenta

• magenta(message: string): string

  Return the provided message so that the foreground is magenta. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

orange

• orange(message: string): string

  Return the provided message so that the foreground is orange. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

primary

• primary(message: string): string

  Return the provided message so that the foreground is colored as primary content. This is the default calor applied. The actual color will depend on the value of darkMode. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

print

• print(message: string, icon?: Icon): Promise<void>

  Print a message on stdout. Will be displayed as primary content if colorEnabled is true.

  Parameters

  • message: string

    the message to output.

  • Optionalicon: Icon

    optional icon to display with the message.

  Returns Promise<void>

red

• red(message: string): string

  Return the provided message so that the foreground is red. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

secondary

• secondary(message: string): string

  Return the provided message so that the foreground is colored as secondary content. The actual color will depend on the value of darkMode. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

selected

• selected(message: string): string

  Return the provided message so that the background is colored as selected content. The actual color will depend on the value of darkMode. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

setLevel

• setLevel(level: Level): Promise<void>

  Set the output threshold Level for stderr.

  Default level is Level.INFO.

  Parameters

  • level: Level

    any message below this level will be filtered from output,

  Returns Promise<void>

showProgressBar

• showProgressBar(options?: ProgressBarOptions): Promise<number>

  Display a progress bar on stderr.

  The progress will be displayed in green if colorEnabled is true.

  NOTE: The progress bar and message will be displayed at Level.INFO level.

  NOTE: If the spinner is currently displayed it will be hidden.

  Parameters

  • options: ProgressBarOptions = {}

    options for the progress bar - see ProgressBarOptions.

  Returns Promise<number>

  a handle to use when invoking updateProgressBar.

showSpinner

• showSpinner(message?: string, style?: SpinnerStyle): Promise<void>

  Display the spinner on stderr.

  The spinner will be displayed as emphasised content and the message will be displayed as primary content if colorEnabled is true.

  NOTE: The spinner and message will be displayed at Level.INFO level.

  NOTE: If the spinner is already displayed the message will be updated to that specified.

  NOTE: If any progress bars are currently displayed they will be hidden.

  Parameters

  • Optionalmessage: string

    the message to output after the spinner.

  • Optionalstyle: SpinnerStyle

    optional spinner animation style, defaults to SpinnerStyle.BOX.

  Returns Promise<void>

startMark

• startMark(): void

  Start tracking the terminal rows occupied by subsequent writes so they can later be erased via clearMarked. Only one mark region can be active at a time.

  Throws if called while already marking.

  Returns void

startQuote

• startQuote(hexFormattedColor?: string): void

  Start a quoted, indented block of output. While active, every line written via print, debug, info, warn or error is prefixed with box-drawing indent characters. Quotes can be nested by calling startQuote again before calling endQuote; each nesting level renders in its own color and adds another indent column.

  Parameters

  • OptionalhexFormattedColor: string

    optional color for this level's indent characters, e.g. "#rrggbb". Defaults to the secondary theme color if not specified.

  Returns void

stderrColumns

• stderrColumns(): number

  The number of columns available on the stderr terminal. Defaults to 80 if the terminal width cannot be determined.

  Returns number

stdoutColumns

• stdoutColumns(): number

  The number of columns available on the stdout terminal. Defaults to 80 if the terminal width cannot be determined.

  Returns number

updateProgressBar

• updateProgressBar(handle: number, current: number, message?: string): void

  Update a specific progress bar.

  Parameters

  • handle: number

    the handle referring to the progress bar to be updated.

  • current: number

    the current value to set on the progress bar.

  • Optionalmessage: string

    an optional message to set on the progress bar, if not specified the initially specified message will be displayed.

  Returns void

violet

• violet(message: string): string

  Return the provided message so that the foreground is violet. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string

warn

• warn(message: string, icon?: Icon): Promise<void>

  Print a Level.WARN level message on stderr. Will be displayed as yellow content if colorEnabled is true.

  Parameters

  • message: string

    the message to output.

  • Optionalicon: Icon

    optional icon to display with the message.

  Returns Promise<void>

yellow

• yellow(message: string): string

  Return the provided message so that the foreground is yellow. Has no effect if colorEnabled is false.

  Parameters

  • message: string

  Returns string