Skip to main content


Extends: object

Generic options for the majority of screen reader operations.

For example, use when starting VoiceOver:

import { voiceOver } from "@guidepup/guidepup";

const startCommandOptions = {
capture: true,
retries: 3,
timeout: 10000,

(async () => {
// Start VoiceOver with custom output capture, timeout, and retries.
await voiceOver.start(commandOptions);

Note: this configuration is used for each sub-operation of a command, they do not necessarily apply to the command as a whole.

See also:



Optional: 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.

Type: boolean | "initial"


Optional: Number of times to retry.

Default is 3.

Type: number


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

Default is 10000.

Type: number