feat: add new guidepup api docs

guidepup · Dec 29, 2023 · 967faed · 967faed
1 parent c67bebd
commit 967faed
Show file tree

Hide file tree

Showing 40 changed files with 1,415 additions and 1,070 deletions.
diff --git a/docs/api/class-click-options.md b/docs/api/class-click-options.md
@@ -38,13 +38,13 @@ import { voiceOver } from "@guidepup/guidepup";
 
 **Optional:** Mouse button to click. One of: `"left"`, `"right"`. Defaults to `"left"` if not provided.
 
-**Type:** &#60;[string]&#62;
+**Type:** [string]
 
 ## clickOptions.clickCount {#click-options-click-count}
 
 **Optional:** Number of times to click the mouse. One of: `1`, `2`, `3`. Defaults to `1` if not provided.
 
-**Type:** &#60;[number]&#62;
+**Type:** [number]
 
 [commandoptions]: ./class-command-options "CommandOptions"
 [number]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number "number"

diff --git a/docs/api/class-command-options.md b/docs/api/class-command-options.md
@@ -46,23 +46,23 @@ See also:
 
 Default is `true`.
 
-**Type:** &#60;[boolean] | "initial"&#62;
+**Type:** [boolean] | "initial"
 
 ## commandOptions.retries {#command-options-retries}
 
 **Optional:** Number of times to retry.
 
 Default is `3`.
 
-**Type:** &#60;[number]&#62;
+**Type:** [number]
 
 ## commandOptions.timeout {#command-options-timeout}
 
 **Optional:** How long to wait until the command times out in ms.
 
 Default is `10000`.
 
-**Type:** &#60;[number]&#62;
+**Type:** [number]
 
 [clickoptions]: ./class-click-options "ClickOptions"
 [keyboardoptions]: ./class-keyboard-options "KeyboardOptions"

diff --git a/docs/api/class-guidepup-virtual-screen-reader.md b/docs/api/class-guidepup-virtual-screen-reader.md
@@ -77,7 +77,7 @@ describe("Screen Reader Tests", () => {
 
 ## guidepupVirtualScreenReader.virtual {#guidepupVirtualScreenReader-virtual}
 
-**Type:** &#60;[Virtual]&#62;
+**Type:** [Virtual]
 
 This object can be used to launch and control the Virtual Screen Reader.
 

diff --git a/docs/api/class-guidepup.md b/docs/api/class-guidepup.md
@@ -46,95 +46,140 @@ import { voiceOver } from "@guidepup/guidepup";
 - [guidepup.windowsOSActivate](./class-guidepup#guidepup-windows-activate)
 - [guidepup.WindowsKeyCodes](./class-guidepup#guidepup-windows-key-codes)
 - [guidepup.WindowsModifiers](./class-guidepup#guidepup-windows-modifiers)
+- [guidepup.windowsRecord](./class-guidepup#guidepup-windows-record)
 - [guidepup.windowsQuit](./class-guidepup#guidepup-windows-quit)
 
 ## guidepup.macOSActivate {#guidepup-macos-activate}
 
-**Type:** &#60;[macOSActivate]&#62;
+**See:** [macOSActivate]
 
 Opens a MacOS application if not already open, and focuses the application.
 
 ## guidepup.MacOSApplications {#guidepup-macos-applications}
 
-**Type:** &#60;[MacOSApplications]&#62;
+**Type:** [MacOSApplications]
 
 Identifiers for standard applications available on MacOS.
 
 ## guidepup.MacOSKeyCodes {#guidepup-macos-key-codes}
 
-**Type:** &#60;[MacOSKeyCodes]&#62;
+**Type:** [MacOSKeyCodes]
 
 Key codes for MacOS.
 
 ## guidepup.MacOSModifiers {#guidepup-macos-modifiers}
 
-**Type:** &#60;[MacOSModifiers]&#62;
+**Type:** [MacOSModifiers]
 
 Modifier keys for MacOS.
 
 ## guidepup.macOSQuit {#guidepup-macos-quit}
 
-**Type:** &#60;[macOSQuit]&#62;
+**See:** [macOSQuit]
 
 Quits a MacOS application if running.
 
 ## guidepup.macOSRecord {#guidepup-macos-record}
 
-**Type:** &#60;[macOSRecord]&#62;
+**See:** [macOSRecord]
 
 Start a screen recording.
 
 ## guidepup.nvda {#guidepup-nvda}
 
-**Type:** &#60;[NVDA]&#62;
+**Type:** [NVDA]
 
 This object can be used to launch and control NVDA.
 
+Here's a typical example:
+
+```ts
+import { nvda } from "@guidepup/guidepup";
+
+(async () => {
+  // Start NVDA.
+  await nvda.start();
+
+  // Move to the next item.
+  await nvda.next();
+
+  // ... perform some commands.
+
+  // Stop NVDA.
+  await nvda.stop();
+})();
+```
+
 ## guidepup.NVDAKeyCodeCommands {#guidepup-nvda-key-code-commands}
 
-**Type:** &#60;[NVDAKeyCodeCommands]&#62;
+**Type:** [NVDAKeyCodeCommands]
 
 [Key code commands for the NVDA screen reader](https://www.nvaccess.org/files/nvda/releases/2021.2/documentation/keyCommands.html) on Windows.
 
 ## guidepup.voiceOver {#guidepup-voiceover}
 
-**Type:** &#60;[VoiceOver]&#62;
+**Type:** [VoiceOver]
 
 This object can be used to launch and control VoiceOver.
 
+Here's a typical example:
+
+```ts
+import { voiceOver } from "@guidepup/guidepup";
+
+(async () => {
+  // Start VoiceOver.
+  await voiceOver.start();
+
+  // Move to the next item.
+  await voiceOver.next();
+
+  // ... perform some commands.
+
+  // Stop VoiceOver.
+  await voiceOver.stop();
+})();
+```
+
 ## guidepup.VoiceOverCommanderCommands {#guidepup-voiceover-commander-commands}
 
-**Type:** &#60;[VoiceOverCommanderCommands]&#62;
+**Type:** [VoiceOverCommanderCommands]
 
 [VoiceOver Commander](https://support.apple.com/en-gb/guide/voiceover/cpvoukbcmdr/mac) commands.
 
 ## guidepup.voiceOverKeyCodeCommands {#guidepup-voiceover-key-code-commands}
 
-**Type:** &#60;[voiceOverKeyCodeCommands]&#62;
+**See:** [voiceOverKeyCodeCommands]
 
 [Key code commands for the VoiceOver screen reader](https://www.apple.com/voiceover/info/guide/_1131.html) on MacOS.
 
 ## guidepup.windowsActivate {#guidepup-windows-activate}
 
-**Type:** &#60;[windowsActivate]&#62;
+**See:** [windowsActivate]
 
 Opens a Windows application if not already open, and focuses the application.
 
 ## guidepup.WindowsKeyCodes {#guidepup-windows-key-codes}
 
-**Type:** &#60;[WindowsKeyCodes]&#62;
+**Type:** [WindowsKeyCodes]
 
 Key codes for Windows.
 
 ## guidepup.WindowsModifiers {#guidepup-windows-modifiers}
 
-**Type:** &#60;[WindowsModifiers]&#62;
+**Type:** [WindowsModifiers]
 
 Modifier keys for Windows.
 
+## guidepup.windowsRecord {#guidepup-windows-record}
+
+**See:** [windowsRecord]
+
+Start a screen recording.
+
 ## guidepup.windowsQuit {#guidepup-windows-quit}
 
-**Type:** &#60;[windowsQuit]&#62;
+**See:** [windowsQuit]
 
 Quits a Windows application if running.
 
@@ -152,4 +197,5 @@ Quits a Windows application if running.
 [windowsactivate]: ./class-windows-activate "windowsActivate"
 [windowskeycodes]: ./class-windows-key-codes "WindowsKeyCodes"
 [windowsmodifiers]: ./class-windows-modifiers "WindowsModifiers"
+[windowsrecord]: ./class-windows-record "windowsRecord"
 [windowsquit]: ./class-windows-quit "windowsQuit"
diff --git a/docs/api/class-key-code-command.md b/docs/api/class-key-code-command.md
@@ -50,13 +50,13 @@ See also:
 
 The key code or key codes to send.
 
-**Type:** &#60;[any] | [Array]<[any]>&#62;
+**Type:** [any] | [Array]<[any]>
 
 ## keyCodeCommand.modifiers {#key-code-command-modifiers}
 
 **Optional:** List of modifier keys to press while sending the key code(s).
 
-**Type:** &#60;[Array]<[string]>&#62;
+**Type:** [Array]<[string]>
 
 [macoskeycodecommand]: ./class-macos-key-code-command "MacOSKeyCodeCommand"
 [voiceoverkeycodecommands]: ./class-voiceover-key-code-commands "VoiceOverKeyCodeCommands"

diff --git a/docs/api/class-keyboard-command.md b/docs/api/class-keyboard-command.md
@@ -2,7 +2,7 @@
 title: "KeyboardCommand"
 ---
 
-**Type:** &#60;[KeyCodeCommand] | [KeystrokeCommand]&#62;
+**Type:** [KeyCodeCommand] | [KeystrokeCommand]
 
 Abstract type representing one of: [KeyCodeCommand], [KeystrokeCommand].
 

diff --git a/docs/api/class-keyboard-options.md b/docs/api/class-keyboard-options.md
@@ -36,7 +36,7 @@ const safariKeyboardOptions = {
 
 **Optional:** Identifier for target application. If not provided, the current focused application will be targeted.
 
-**Type:** &#60;[string]&#62;
+**Type:** [string]
 
 See also:
 

diff --git a/docs/api/class-keystroke-command.md b/docs/api/class-keystroke-command.md
@@ -47,13 +47,13 @@ See also:
 
 The character(s) to send.
 
-**Type:** &#60;[string]&#62;
+**Type:** [string]
 
 ## keystrokeCommand.modifiers {#keystroke-command-modifiers}
 
 **Optional:** List of modifier keys to press while sending the character(s).
 
-**Type:** &#60;[Array]<[string]>&#62;
+**Type:** [Array]<[string]>
 
 [macoskeystrokecommand]: ./class-macos-keystroke-command "MacOSKeystrokeCommand"
 [array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array "Array"

diff --git a/docs/api/class-macos-activate.md b/docs/api/class-macos-activate.md
@@ -21,10 +21,10 @@ import { macOSActivate, MacOSApplications } from "@guidepup/guidepup";
 
 **Parameters:**
 
-- `applicationName` &#60;[string]&#62; Application identifier. See [MacOSApplications].
-- **Optional:** `options` &#60;[CommandOptions]&#62; Additional options.
+- `applicationName` [string] Application identifier. See [MacOSApplications].
+- **Optional:** `options` [CommandOptions] Additional options.
 
-**Returns:** &#60;[Promise]<[void]>&#62;
+**Returns:** [Promise]<[void]>
 
 [commandoptions]: ./class-command-options "CommandOptions"
 [macosapplications]: ./class-macos-applications "MacOSApplications"

diff --git a/docs/api/class-macos-key-code-command.md b/docs/api/class-macos-key-code-command.md
@@ -53,25 +53,25 @@ See also:
 
 **Optional:** Description of the action the key code performs.
 
-**Type:** &#60;[string]&#62;
+**Type:** [string]
 
 ## macOSKeyCodeCommand.keyCode {#key-code-command-key-code}
 
 The key code or key codes to send. See [MacOSKeyCodes] for available key codes.
 
-**Type:** &#60;[number] | [Array]<[number]>&#62;
+**Type:** [number] | [Array]<[number]>
 
 ## macOSKeyCodeCommand.modifiers {#key-code-command-modifiers}
 
 **Optional:** List of modifier keys to press while sending the key code(s).
 
-**Type:** &#60;[Array]<[MacOSModifiers]>&#62;
+**Type:** [Array]<[MacOSModifiers]>
 
 ## macOSKeyCodeCommand.representation {#key-code-command-representation}
 
 **Optional:** Symbolic representation of the key code(s) and modifier keys this command uses.
 
-**Type:** &#60;[string]&#62;
+**Type:** [string]
 
 [keycodecommand]: ./class-key-code-command "KeyCodeCommand"
 [macoskeycodes]: ./class-macos-key-codes "MacOSKeyCodes"