(#87) Keyboard API docs

Author: s1hofmann

Diff for: lib/keyboard.class.ts

@@ -8,16 +8,33 @@ const inputIsString = (input: string[] | Key[]): input is string[] => {
   return input.every((elem: string | Key) => typeof elem === "string");
 };
 
+/**
+ * {@link Keyboard} class provides methods to emulate keyboard input
+ */
 export class Keyboard {
 
+  /**
+   * Config object for {@link Keyboard} class
+   */
   public config = {
+    /**
+     * Configures the delay between single key events
+     */
     autoDelayMs: 300,
   };
 
+  /**
+   * {@link Keyboard} class constructor
+   * @param nativeAdapter {@link NativeAdapter} instance which bundles access to mouse, keyboard and clipboard
+   */
   constructor(private nativeAdapter: NativeAdapter) {
     this.nativeAdapter.setKeyboardDelay(this.config.autoDelayMs);
   }
 
+  /**
+   * {@link type} types a sequence of {@link String} or single {@link Key}s via system keyboard
+   * @param input Sequence of {@link String} or {@link Key} to type
+   */
   public type(...input: StringOrKey): Promise<Keyboard> {
     return new Promise<Keyboard>(async (resolve, reject) => {
       try {
@@ -36,6 +53,17 @@ export class Keyboard {
     });
   }
 
+  /**
+   * {@link pressKey} presses and holds a single {@link Key} for {@link Key} combinations
+   * Modifier {@link Key}s are to be given in "natural" ordering, so first modifier {@link Key}s, followed by the {@link Key} to press
+   * @example
+   * ```typescript
+   *    // Will press and hold key combination STRG + V
+   *    await keyboard.pressKey(Key.STRG, Key.A);
+   * ```
+   *
+   * @param keys Array of {@link Key}s to press and hold
+   */
   public pressKey(...keys: Key[]): Promise<Keyboard> {
     return new Promise<Keyboard>(async (resolve, reject) => {
       try {
@@ -47,6 +75,17 @@ export class Keyboard {
     });
   }
 
+  /**
+   * {@link pressKey} releases a single {@link Key} for {@link Key} combinations
+   * Modifier {@link Key}s are to be given in "natural" ordering, so first modifier {@link Key}s, followed by the {@link Key} to press
+   * @example
+   * ```typescript
+   *    // Will release key combination STRG + V
+   *    await keyboard.releaseKey(Key.STRG, Key.A);
+   * ```
+   *
+   * @param keys Array of {@link Key}s to release
+   */
   public releaseKey(...keys: Key[]): Promise<Keyboard> {
     return new Promise<Keyboard>(async (resolve, reject) => {
       try {