Merge pull request #119 from anoadragon453/anoa/unregister_keys

Ability to unregister a shortcut via the shortcut's keys

docs/usage.md

@@ -164,9 +164,17 @@ You can unregister shortcut by using shortcutId returned by `registerShortcut()`
 ioHook.unregisterShortcut(id);
 ```
 
+### unregisterShortcutByKeys(keys)
+
+You can unregister shortcut by using the keys codes passed to `registerShortcut()`. Passing codes in the same order as during registration is not required.
+
+```js
+ioHook.unregisterShortcutByKeys(keys);
+```
+
 ### unregisterAllShortcuts()
 
-You can also unregister all shortcuts
+You can also unregister all shortcuts.
 ```js
 ioHook.unregisterAllShortcuts();
 ```

index.d.ts

@@ -59,6 +59,12 @@ declare class IOHook extends EventEmitter {
    */
   unregisterShortcut(shortcutId: number): void
 
+  /**
+   * Unregister shortcut via its key codes
+   * @param {Array<string|number>} keys
+   */
+  unregisterShortcut(keys: Array<string|number>): void
+
   /**
    * Unregister all shortcuts
    */

index.js

@@ -95,6 +95,47 @@ class IOHook extends EventEmitter {
     });
   }
 
+  /**
+   * Unregister shortcut via its key codes
+   * @param {string} keyCodes Keyboard keys matching the shortcut that should be unregistered
+   */
+  unregisterShortcutByKeys(keyCodes) {
+    // A traditional loop is used in order to access `this` from inside
+    for (let i = 0; i < this.shortcuts.length; i++) {
+      let shortcut = this.shortcuts[i];
+
+      // Convert any keycode numbers to strings
+      keyCodes.forEach((key, index) => {
+        if (typeof key !== 'string' && !(key instanceof String)) {
+          // Convert to string
+          keyCodes[index] = key.toString();
+        }
+      })
+
+      // Check if this is our shortcut
+      Object.keys(shortcut).every(key => {
+        if (key === 'callback' || key === 'id') return;
+
+        // Remove all given keys from keyCodes
+        // If any are not in this shortcut, then this shortcut does not match
+        // If at the end we have eliminated all codes in keyCodes, then we have succeeded
+        let index = keyCodes.indexOf(key);
+        if (index === -1) return false; // break
+
+        // Remove this key from the given keyCodes array
+        keyCodes.splice(index, 1);
+        return true;
+      });
+
+      // Is this the shortcut we want to remove?
+      if (keyCodes.length === 0) {
+        // Unregister this shortcut
+        this.shortcuts.splice(i, 1);
+        return;
+      }
+    }
+  }
+
   /**
    * Unregister all shortcuts
    */

test/specs/keyboard.spec.js

@@ -196,4 +196,27 @@ describe('Keyboard events', () => {
       robot.keyToggle('shift', 'up');
     }, 50);
   });
+
+  it('can unregister a shortcut via its keycodes', (done) => {
+    expect.assertions(0);
+
+    let shortcut = [42, 30];
+
+    // Register the shortcut
+    ioHook.registerShortcut(shortcut, (event) => {
+      // We're unregistering this shortcut. It should not have been called
+      expect.not.toHaveBeenCalled();
+    });
+
+    // Unregister the shortcut
+    ioHook.unregisterShortcutByKeys(shortcut);
+
+    ioHook.start();
+
+    setTimeout(() => { // Make sure ioHook starts before anything gets typed
+      robot.keyToggle('shift', 'down');
+      robot.keyTap('a');
+      robot.keyToggle('shift', 'up');
+    }, 50);
+  });
 });