UserInputA terminal input event containing an optional raw character and the parsed key that was pressed.
When to use
Use when consuming low-level terminal input events from Terminal.readInput
and you need both raw character input and parsed key metadata.
modelsKey
Source effect/Terminal.ts:9710 lines
export interface UserInput {
/**
* The character read from the user (if any).
*/
readonly UserInput.input: Option.Option<string>The character read from the user (if any).
input: import OptionOption.type Option.Option = /*unresolved*/ anyOption<string>
/**
* The key that the user pressed.
*/
readonly UserInput.key: Key(property) UserInput.key: {
name: string;
ctrl: boolean;
meta: boolean;
shift: boolean;
}
The key that the user pressed.
key: Key
}Referenced by 2 symbols