Interface KeyboardOptions

interface KeyboardOptions {
    application?: string;
    capture?: boolean | "initial";
    retries?: number;
    timeout?: number;
}

Hierarchy (view full)

Properties

application?: string

Optional identifier for target application.

If not provided, the current focused application will be targeted.

capture?: boolean | "initial"

Whether to capture the screen reader output:

  • true will enabled full capture.
  • "initial" will capture the first "page" of output, but not any subsequent content.
  • false will disable capture.

Default is true.

retries?: number

Number of times to retry.

timeout?: number

How long to wait until the command times out in ms.