Class TtyKeyReader

Implements

KeyReader

Index

Constructors

Methods

disableRawMode enableRawMode readKey readRaw

Constructors

constructor

new TtyKeyReader(ttyReadStream: ReadStream): TtyKeyReader
Parameters
- ttyReadStream: ReadStream
Returns TtyKeyReader
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/terminal/TtyKeyReader.ts:9

Methods

disableRawMode

disableRawMode(): void
Returns void
Implementation of KeyReader.disableRawMode
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/terminal/TtyKeyReader.ts:21

enableRawMode

enableRawMode(): void
Returns void
Implementation of KeyReader.enableRawMode
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/terminal/TtyKeyReader.ts:16

readKey

readKey(): Promise<KeyEvent>
Returns Promise<KeyEvent>
Implementation of KeyReader.readKey
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/terminal/TtyKeyReader.ts:26

readRaw

readRaw(
isComplete: (received: string) => boolean,
timeoutMs: number,
): Promise<string>
Read raw input until isComplete returns true for the accumulated input or timeoutMs elapses. Raw mode and paused state are restored afterwards.
Parameters
- isComplete: (received: string) => boolean
- timeoutMs: number
Returns Promise<string>
the accumulated input.
Implementation of KeyReader.readRaw
- Defined in work/dynamic-cli-framework/dynamic-cli-framework/src/terminal/TtyKeyReader.ts:55