Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IHandlerResponseConsoleApi

Handler response API for console messages.

export
interface

IHandlerResponseConsoleApi

Hierarchy

  • IHandlerResponseConsoleApi

Index

Methods

Methods

error

  • error(message: string | Buffer, ...values: any[]): string

  • Write a message to stderr (or buffers in silent/JSON mode). Automatically appends a newline to the message.

    memberof

    IHandlerResponseConsoleApi

    Parameters

    • message: string | Buffer

      The message (or format string) to write to stderr

    • Rest ...values: any[]

      The format string values for substitution/formatting.

    Returns string

    • The verbatim message written.

errorHeader

  • errorHeader(message: string, delimiter?: string): string

  • Writes an error header to stderr. The header is colorized (to red), appends a colon (e.g. "Syntax Error:"), and a new line. The intention of the error header is to begin an error block of text with a "tag" (the header).

    memberof

    IHandlerResponseConsoleApi

    Parameters

    • message: string

      The message as the header.

    • Optional delimiter: string

    Returns string

log

  • log(message: string | Buffer, ...values: any[]): string

  • Write a message to stdout (or buffers in silent/JSON mode). Automatically appends a newline to the message.

    memberof

    IHandlerResponseConsoleApi

    Parameters

    • message: string | Buffer

      The message (or format string) to write to stdout.

    • Rest ...values: any[]

      The format string values for substitution/formatting.

    Returns string

    • The verbatim message written.

prompt

Generated using TypeDoc