Class BaseTerminal

Hierarchy

Constructors

constructor

Properties

aborted ansi cursorShown interface lineBuffer logger muted storedWrite streamErrBuffer streamLevel streamOutBuffer streamPad streamPrefix streaming terminalAnimation theme

Methods

abort close endStream hideCursor internalStreamResizeListener mute showCursor startStream streamResizeListener unmute

Constructors

constructor

Properties

Protected aborted

aborted: boolean = false

Protected Readonly ansi

ansi: boolean

Protected cursorShown

cursorShown: boolean = true

Protected interface

interface: Interface = ...

Protected lineBuffer

lineBuffer: string = null

Protected logger

logger: Logger

Protected muted

muted: boolean = false

Protected Readonly storedWrite

storedWrite: { (buffer: string | Uint8Array, cb?: ((err?: Error) => void)): boolean; (str: string | Uint8Array, encoding?: BufferEncoding, cb?: ((err?: Error) => void)): boolean } = process.stdout.write

Type declaration

    • (buffer: string | Uint8Array, cb?: ((err?: Error) => void)): boolean

    • Sends data on the socket. The second parameter specifies the encoding in the case of a string. It defaults to UTF8 encoding.

      Returns true if the entire data was flushed successfully to the kernel buffer. Returns false if all or part of the data was queued in user memory.'drain' will be emitted when the buffer is again free.

      The optional callback parameter will be executed when the data is finally written out, which may not be immediately.

      See Writable stream write() method for more information.

      Since

      v0.1.90

      Parameters

      • buffer: string | Uint8Array
      • Optional cb: ((err?: Error) => void)
          • (err?: Error): void

          • Parameters

            • Optional err: Error

            Returns void

      Returns boolean

    • (str: string | Uint8Array, encoding?: BufferEncoding, cb?: ((err?: Error) => void)): boolean

    • Parameters

      • str: string | Uint8Array
      • Optional encoding: BufferEncoding
      • Optional cb: ((err?: Error) => void)
          • (err?: Error): void

          • Parameters

            • Optional err: Error

            Returns void

      Returns boolean

Protected streamErrBuffer

streamErrBuffer: string = null

Protected streamLevel

streamLevel: number = null

Protected streamOutBuffer

streamOutBuffer: string = null

Protected streamPad

streamPad: number = null

Protected Readonly streamPrefix

streamPrefix: "| " = "| "

Protected streaming

streaming: boolean = false

Protected terminalAnimation

terminalAnimation: TerminalAnimation = null

Protected theme

theme: Theme

Methods

abort

  • Returns void

Protected close

  • Parameters

    • final: boolean = true

    Returns void

endStream

  • Returns { err: string; out: string }

    • err: string
    • out: string

hideCursor

  • Returns void

Protected internalStreamResizeListener

  • Returns void

mute

  • Returns void

showCursor

  • Returns void

startStream

  • Parameters

    Returns ((chunk: string, isError?: boolean) => void)

      • (chunk: string, isError?: boolean): void

      • Parameters

        • chunk: string
        • Optional isError: boolean

        Returns void

Protected Readonly streamResizeListener

  • Returns void

unmute

  • Returns void

Settings

Member Visibility

Theme