Interface ClickOptions

interface ClickOptions {
    button?: "left" | "right";
    capture?: boolean | "initial";
    clickCount?: 1 | 2 | 3;
    retries?: number;
    timeout?: number;
}

Hierarchy (view full)

Properties

button? capture? clickCount? retries? timeout?

Properties

Optionalbutton

button?: "left" | "right"

Defaults to left.

Optionalcapture

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.

OptionalclickCount

clickCount?: 1 | 2 | 3

Defaults to 1.

Optionalretries

retries?: number

Number of times to retry.

Optionaltimeout

timeout?: number

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

Settings

Member Visibility

On This Page

Properties