Class BufferedTerminal

Hierarchy

Constructors

constructor

Properties

aborted ansi answerCount ascii asking buffer cursorShown integerRe interface lineBuffer listKeypressListener listResizeListener logger maxFailure multiSelection multipleIntegerRe multipleSpaceRe multipleSplitRe muted nonMultiSelectionList passwordPrompt questionPrompt responseAbort responseTimeout selection selectionAnswers selectionList selectionType storedWrite streamErrBuffer streamLevel streamOutBuffer streamPad streamPrefix streaming terminalAnimation theme timedOutResponse timeoutMs

Methods

abort ask close endGetResponse endStream failResponse getAnswer getListResponse getMultiAnswer getResponse hideCursor interactiveAbort interactiveAccept interactiveMove interactiveSelect interactiveStart internalListKeypressListener internalListResizeListener internalStreamResizeListener mute renderListHighlight renderNonMultiSelectionList sanitizeOptionAnswers showCursor splitMultiResponse startStream streamResizeListener unmute validateAnswer validateMultiAnswer

Constructors

constructor

Properties

Protected aborted

aborted: boolean = false

Protected Readonly ansi

ansi: boolean

Protected answerCount

answerCount: number

Protected ascii

ascii: Ascii

Protected asking

asking: boolean = false

Protected buffer

buffer: string[] = null

Protected cursorShown

cursorShown: boolean = true

Protected Readonly integerRe

integerRe: RegExp = ...

Protected interface

interface: Interface = ...

Protected lineBuffer

lineBuffer: string = null

Protected Readonly listKeypressListener

listKeypressListener: ((_: string, key: Key) => void)

Type declaration

    • (_: string, key: Key): void

    • Parameters

      • _: string
      • key: Key

      Returns void

Protected Readonly listResizeListener

listResizeListener: (() => void)

Type declaration

    • (): void

    • Returns void

Protected logger

logger: Logger

Protected Readonly maxFailure

maxFailure: 5 = 5

Protected multiSelection

multiSelection: number[] = null

Protected Readonly multipleIntegerRe

multipleIntegerRe: RegExp = ...

Protected Readonly multipleSpaceRe

multipleSpaceRe: RegExp = ...

Protected Readonly multipleSplitRe

multipleSplitRe: RegExp = ...

Protected muted

muted: boolean = false

Protected nonMultiSelectionList

nonMultiSelectionList: string[]

Protected Readonly passwordPrompt

passwordPrompt: string

Protected Readonly questionPrompt

questionPrompt: string

Protected responseAbort

responseAbort: (() => void)

Type declaration

    • (): void

    • Returns void

Protected responseTimeout

responseTimeout: Timeout

Protected selection

selection: number = null

Protected selectionAnswers

selectionAnswers: string[]

Protected selectionList

selectionList: string[]

Protected selectionType

selectionType: ListType

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

Protected timedOutResponse

timedOutResponse: boolean

Protected timeoutMs

timeoutMs: number

Methods

abort

ask

  • Parameters

    Returns Promise<string | string[]>

Protected close

  • Parameters

    • final: boolean = true

    Returns void

Protected endGetResponse

  • Parameters

    • answer: string
    • password: boolean = false
    • timedOut: boolean = false

    Returns string

endStream

  • Returns { err: string; out: string }

    • err: string
    • out: string

Protected failResponse

  • Parameters

    • response: string
    • text: string
    • answers: string[]
    • listDescriptions: boolean | string[] = false
    • multi: boolean = false
    • allowNone: boolean = false

    Returns Promise<string | string[]>

Protected getAnswer

  • Parameters

    • text: string
    • answers: string[]
    • listDescriptions: boolean | string[] = false
    • allowNone: boolean = false

    Returns Promise<string>

Protected getListResponse

  • Parameters

    • text: string
    • answers: string[]
    • Optional descriptions: string[]
    • type: ListType = ListType.NUMERIC

    Returns Promise<string>

Protected getMultiAnswer

  • Parameters

    • text: string
    • answers: string[]
    • listDescriptions: boolean | string[] = false
    • allowNone: boolean = false

    Returns Promise<string[]>

Protected getResponse

  • Parameters

    • text: string
    • password: boolean = false

    Returns Promise<string>

hideCursor

Protected interactiveAbort

Protected interactiveAccept

Protected interactiveMove

Protected interactiveSelect

Protected interactiveStart

Protected internalListKeypressListener

Protected internalListResizeListener

Protected internalStreamResizeListener

mute

Protected renderListHighlight

  • Parameters

    • selection: number
    • content: string
    • prevSelection: number = null
    • prevContent: string = null

    Returns void

Protected renderNonMultiSelectionList

Protected sanitizeOptionAnswers

showCursor

Protected splitMultiResponse

  • Parameters

    • response: string

    Returns string[]

startStream

  • Parameters

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

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

      • Parameters

        • chunk: string
        • Optional isError: boolean

        Returns void

Protected Readonly streamResizeListener

unmute

Protected validateAnswer

  • Parameters

    • response: string
    • answers: string[]
    • type: ListType
    • allowNone: boolean = false

    Returns string

Protected validateMultiAnswer

  • Parameters

    • response: string
    • answers: string[]
    • listType: ListType
    • allowNone: boolean

    Returns string[]

Settings

Member Visibility

Theme