Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChatShell

Hierarchy

Index

Constructors

constructor

Properties

Protected active

active: boolean = false

Protected cursor

cursor: number = 0

Protected line

line: string = ""

Readonly session

session: ISshSession

Readonly stream

stream: ISshStream

Methods

Protected allowCtrlCClose

  • allowCtrlCClose(): boolean
  • Check if Ctrl+C is allowed to close the shell

    Returns boolean

    True if you want ctrl+c to close the shell

allowHistory

  • allowHistory(): void
  • Returns void

displayMessage

executeWithMessageRedirect

  • executeWithMessageRedirect(executor: () => Promise<void>): Promise<void>

flush

  • flush(): void
  • Returns void

processData

  • processData(data: string): Promise<Shell | false | undefined>
  • Parameters

    • data: string

    Returns Promise<Shell | false | undefined>

processLine

  • processLine(line: string): Promise<Shell | false | undefined>
  • Processes a line sent for the session

    Parameters

    • line: string

    Returns Promise<Shell | false | undefined>

    A shell to push a new action shell, false to exit the session, undefined to keep the active shell going

start

  • Returns Promise<boolean>

stop

  • stop(): void
  • Returns void

write

  • write(data: string): void
  • Parameters

    • data: string

    Returns void

writeMarker

  • Writes the marker

    Returns Promise<void>

Generated using TypeDoc