@flowscripter/dynamic-cli-framework
    Preparing search index...

    Interface KeyReader

    interface KeyReader {
        disableRawMode(): void;
        enableRawMode(): void;
        readKey(): Promise<KeyEvent>;
        readRaw(
            isComplete: (received: string) => boolean,
            timeoutMs: number,
        ): Promise<string>;
    }

    Implemented by

    Index
    disableRawMode enableRawMode readKey readRaw

    • 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.

    Settings
    Member Visibility

    On This Page
    Methods