Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ShellAdapter

Load prompts and render chat in shell, for testing interactions

Hierarchy

Index

Constructors

constructor

Properties

bot

bot: Bot

debug

debug: boolean = false

line

line: Separator = new inquirer.Separator()

logs

logs: string[] = ['']

messages

messages: [string, string][] = []

name

name: string = "shell-message-adapter"

room

room: Room = rooms.blank()

Optional transport

transport: Transport

ui

ui: any

user

user: User = users.blank()

Methods

dispatch

  • dispatch(envelope: Envelope): Promise<void>
  • Add outgoing messages and re-render chat

    Parameters

    Returns Promise<void>

log

  • log(logEvent: any, callback: any): void
  • Write log events to the inquirer UI

    Parameters

    • logEvent: any
    • callback: any

    Returns void

logSetup

  • logSetup(): void
  • Re-route console transport to shell's own logger

    Returns void

prompt

  • prompt(): Promise<void>
  • Prompt for message input, recursive after each render

    Returns Promise<void>

render

  • render(): Promise<void>
  • Update chat window and return to input prompt

    Returns Promise<void>

roomSetup

  • roomSetup(): Promise<void>
  • Write prompt to collect room and user name, or take from env settings

    Returns Promise<void>

shutdown

  • shutdown(): Promise<void>
  • Close inquirer UI and exit process when shutdown complete

    Returns Promise<void>

start

  • start(): Promise<void>
  • Register user and room, then render chat with welcome message

    Returns Promise<void>

Generated using TypeDoc