useTerminalInput
export exported by @mwillbanks/tuil-ink.
export
Public export exported by @mwillbanks/tuil-ink.
export function useTerminalInput(
handler: TerminalInputHandler,
options: {
readonly enabled?: boolean;
readonly priority?: number;
readonly layerId?: string;
} = {},
): void;Members
This declaration has no public members.
Parameters
| Member | Type | Required | Description | Related types |
|---|---|---|---|---|
handler | TerminalInputHandler | Yes | Supplies the handler value as TerminalInputHandler. | TerminalInputHandler |
options | { readonly enabled?: boolean; readonly priority?: number; readonly layerId?: string; } | No | Supplies the options value as { readonly enabled?: boolean; readonly priority?: number; readonly layerId?: string; }. | — |
Returns
void — Returns a value that satisfies void.
Related types: —
Throws
No thrown errors are documented for this declaration.
Related types
Source
View the secondary source reference