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 = {
timeout: 10000,
retries: 3,

(async () => {
// Start VoiceOver with custom 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 whole command.

See also:



Optional: Number of times to retry.

Type: <number>


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

Type: <number>