feat: package upgrades

guidepup · Jan 10, 2024 · 6c922ab · 6c922ab
1 parent c1de784
commit 6c922ab
Show file tree

Hide file tree

Showing 24 changed files with 3,837 additions and 2,918 deletions.
diff --git a/.nvmrc b/.nvmrc
@@ -1 +1 @@
-18
+20
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:** [any] | [Array]<[any]>
+**Type:** [any] | [Array]&#60;[any]&#62
 
 ## keyCodeCommand.modifiers {#key-code-command-modifiers}
 
 **Optional:** List of modifier keys to press while sending the key code(s).
 
-**Type:** [Array]<[string]>
+**Type:** [Array]&#60;[string]&#62
 
 [macoskeycodecommand]: ./class-macos-key-code-command "MacOSKeyCodeCommand"
 [voiceoverkeycodecommands]: ./class-voiceover-key-code-commands "VoiceOverKeyCodeCommands"

diff --git a/docs/api/class-keystroke-command.md b/docs/api/class-keystroke-command.md
@@ -53,7 +53,7 @@ The character(s) to send.
 
 **Optional:** List of modifier keys to press while sending the character(s).
 
-**Type:** [Array]<[string]>
+**Type:** [Array]&#60;[string]&#62;
 
 [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
@@ -24,7 +24,7 @@ import { macOSActivate, MacOSApplications } from "@guidepup/guidepup";
 - `applicationName` [string] Application identifier. See [MacOSApplications].
 - **Optional:** `options` [CommandOptions] Additional options.
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 [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
@@ -59,13 +59,13 @@ See also:
 
 The key code or key codes to send. See [MacOSKeyCodes] for available key codes.
 
-**Type:** [number] | [Array]<[number]>
+**Type:** [number] | [Array]&#60;[number]&#62;
 
 ## macOSKeyCodeCommand.modifiers {#key-code-command-modifiers}
 
 **Optional:** List of modifier keys to press while sending the key code(s).
 
-**Type:** [Array]<[MacOSModifiers]>
+**Type:** [Array]&#60;[MacOSModifiers]&#62;
 
 ## macOSKeyCodeCommand.representation {#key-code-command-representation}
 

diff --git a/docs/api/class-macos-key-codes.md b/docs/api/class-macos-key-codes.md
@@ -158,7 +158,7 @@ List of all key code accessors:
 - <kbd>;</kbd>
 - <kbd>=</kbd>
 - <kbd>[</kbd>
-- <kbd>\</kbd>
+- <kbd>&#92;</kbd>
 - <kbd>]</kbd>
 - <kbd>`</kbd>
 - <kbd>A</kbd>

diff --git a/docs/api/class-macos-keystroke-command.md b/docs/api/class-macos-keystroke-command.md
@@ -59,7 +59,7 @@ The character(s) to send.
 
 **Optional:** List of modifier keys to press while sending the character(s).
 
-**Type:** [Array]<[MacOSModifiers]>
+**Type:** [Array]&#60;[MacOSModifiers]&#62;
 
 ## macOSKeystrokeCommand.representation {#keystroke-command-representation}
 

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

diff --git a/docs/api/class-nvda-key-code-commands.md b/docs/api/class-nvda-key-code-commands.md
@@ -4,7 +4,7 @@ title: "NVDAKeyCodeCommands"
 
 **Extends:** [object]
 
-**Implements:** [Record]<[string], [WindowsKeyCodeCommand]>
+**Implements:** [Record]&#60;[string], [WindowsKeyCodeCommand]&#62;
 
 [Key code commands for the NVDA screen reader](https://www.nvaccess.org/files/nvda/releases/2021.2/documentation/keyCommands.html) on Windows.
 

diff --git a/docs/api/class-nvda.md b/docs/api/class-nvda.md
@@ -93,7 +93,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.clearItemTextLog() {#nvda-clear-item-text-log}
 
@@ -118,7 +118,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.clearSpokenPhraseLog() {#nvda-clear-spoken-phrase-log}
 
@@ -141,7 +141,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.click([options]) {#nvda-click}
 
@@ -172,7 +172,7 @@ import { nvda } from "@guidepup/guidepup";
 
 - **Optional:** `options` [ClickOptions] Click options.
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.default() {#nvda-default}
 
@@ -192,7 +192,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[boolean]>
+**Returns:** [Promise]&#60;[boolean]&#62;
 
 ## nvda.detect() {#nvda-detect}
 
@@ -212,7 +212,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[boolean]>
+**Returns:** [Promise]&#60;[boolean]&#62;
 
 ## nvda.interact() {#nvda-interact}
 
@@ -238,7 +238,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.itemText() {#nvda-item-text}
 
@@ -266,7 +266,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[string]> The item's text.
+**Returns:** [Promise]&#60;[string]&#62; The item's text.
 
 ## nvda.itemTextLog() {#nvda-item-text-log}
 
@@ -295,7 +295,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[Array]<[string]>> The item text log.
+**Returns:** [Promise]&#60;[Array]&#60;[string]&#62;> The item text log.
 
 ## nvda.lastSpokenPhrase() {#nvda-last-spoken-phrase}
 
@@ -320,7 +320,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[string]> The last spoken phrase.
+**Returns:** [Promise]&#60;[string]&#62; The last spoken phrase.
 
 ## nvda.next([options]) {#nvda-next}
 
@@ -347,7 +347,7 @@ import { nvda } from "@guidepup/guidepup";
 
 - **Optional:** `options` [CommandOptions] Additional options.
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.perform(command[, options]) {#nvda-perform}
 
@@ -378,7 +378,7 @@ import { nvda, NVDAKeyCodeCommands } from "@guidepup/guidepup";
 - `command` [WindowsKeyCodeCommand] | [WindowsKeystrokeCommand] NVDA keyboard command.
 - **Optional:** `options` [CommandOptions] Additional options.
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.press(key[, options]) {#nvda-press}
 
@@ -422,7 +422,7 @@ import { nvda } from "@guidepup/guidepup";
 - `key` [string] Name of the key to press or a character to generate, such as <kbd>ArrowLeft</kbd> or <kbd>a</kbd>.
 - **Optional:** `options` [CommandOptions] Additional options.
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.previous([options]) {#nvda-previous}
 
@@ -449,7 +449,7 @@ import { nvda } from "@guidepup/guidepup";
 
 - **Optional:** `options` [CommandOptions] Additional options.
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.spokenPhraseLog() {#nvda-spoken-phrase-log}
 
@@ -476,7 +476,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[Array]<[string]>> The spoken phrase log.
+**Returns:** [Promise]&#60;[Array]&#60;[string]&#62;> The spoken phrase log.
 
 ## nvda.start([options]) {#nvda-start}
 
@@ -500,7 +500,7 @@ import { nvda } from "@guidepup/guidepup";
 
 - **Optional:** `options` [CommandOptions] Additional options.
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.stop() {#nvda-stop}
 
@@ -520,7 +520,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.stopInteracting() {#nvda-stop-interacting}
 
@@ -548,7 +548,7 @@ import { nvda } from "@guidepup/guidepup";
 })();
 ```
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 ## nvda.type(text[, options]) {#nvda-type}
 
@@ -577,7 +577,7 @@ import { nvda } from "@guidepup/guidepup";
 - `text` [string] Text to type into the focused item.
 - **Optional:** `options` [CommandOptions] Additional options.
 
-**Returns:** [Promise]<[void]>
+**Returns:** [Promise]&#60;[void]&#62;
 
 [clickoptions]: ./class-click-options "ClickOptions"
 [commandoptions]: ./class-command-options "CommandOptions"