caique/raw

import { keyOf, canRender, renderList, … } from 'caique/raw';

FunctionsCopy Anchor Link

askListCopy Anchor Link

Drive a list prompt with the arrow keys, repainting in place.

Returns the same Asked shape ask() does, so a caller can swap the two without knowing which ran — and cancels the same way, because Ctrl-C in raw mode is a byte and not a signal, and a person who presses it means to leave.

The cursor is hidden through closeout: the byte path resolves and restore() runs in the finally; every path that never reaches the finally is the exit hook's.

function askList(spec: PromptSpec, io: RawIo, multi?: boolean): Promise<Asked>;

Returns Promise<Asked>

canRenderCopy Anchor Link

Whether this runtime can drive the raw renderer at all.

function canRender(keys: KeyStream): boolean;

Returns boolean

keyOfCopy Anchor Link

What a keypress means. Only the six that drive a list — everything else is other, and a widget that does not know what to do with a key does nothing, which is what a person expects from a key they pressed by accident.

function keyOf(data: string): Key;

Returns Key

renderListCopy Anchor Link

One frame of the list. Exported so a test asserts the drawing rather than a screenshot.

function renderList(spec: PromptSpec, choices: Choice[], state: ListState, multi: boolean): string;

Returns string

InterfacesCopy Anchor Link

KeyStreamCopy Anchor Link

A stream that can be put into raw mode and read a key at a time.

interface KeyStream {
    isTTY?: boolean;
    /**
     * Node's record of the mode. Read so that a stream somebody else already put into raw
     * mode — a prompt library, the program itself — is left raw when this prompt ends.
     */
    isRaw?: boolean;
    setRawMode?(raw: boolean): unknown;
    on(event: 'data', listener: (chunk: Buffer | string) => void): unknown;
    off(event: 'data', listener: (chunk: Buffer | string) => void): unknown;
    resume?(): unknown;
    pause?(): unknown;
}

RawIoCopy Anchor Link

interface RawIo extends Io {
    keys: KeyStream;
}

TypesCopy Anchor Link

KeyCopy Anchor Link

type Key = 'up' | 'down' | 'space' | 'enter' | 'cancel' | 'other';