Interface WatchTerminal

The terminal the loop draws on. Key input and resize notification are optional: absent when stdin is not a TTY, as with a piped run.

interface WatchTerminal {
    keys?(onKey: (key: string) => void): () => void;
    onResize?(listener: () => void): () => void;
    size(): { columns: number; rows: number };
    write(text: string): void;
}

Index

Methods

keys? onResize? size write

Methods

`Optional`keys

keys?(onKey: (key: string) => void): () => void
Raw key input; returns a detach function restoring the previous mode.
Parameters
- onKey: (key: string) => void
Returns () => void
- Defined in packages/module-train/src/watch.ts:501

`Optional`onResize

onResize?(listener: () => void): () => void
Parameters
- listener: () => void
Returns () => void
- Defined in packages/module-train/src/watch.ts:502

size

size(): { columns: number; rows: number }
Returns { columns: number; rows: number }
- Defined in packages/module-train/src/watch.ts:499

write

write(text: string): void
Parameters
- text: string
Returns void
- Defined in packages/module-train/src/watch.ts:498