StartOptions

Extends: CommandOptions

Options for the screen reader start operation.

For example, use when starting VoiceOver:

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

const startCommandOptions = {
  capture: true,
  retries: 3,
  timeout: 10000,
  settings: {
    SCRCUserDefaultsCursorTrackingEnabled: false,
  },
};

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

See also:

• CommandOptions

Contents:

• startOptions.settings

startOptions.settings

Optional: Screen reader settings to apply on startup.

Type: Record<string, unknown>