browser-forward-keyboard-listener - npm Package Compare versions

Comparing version 1.1.3 to 1.2.0

dist/KeyListenersManager.d.ts

@@ -21,14 +21,20 @@ import * as WebSocket from "ws";
 export declare function addKeyDownListener(key: string, callback: SimpleCallback): void;
+export declare function removeKeyDownListener(key: string, callback: SimpleCallback): void;
 export declare function removeKeyDownListeners(key: string): void;
 export declare function addKeyUpListener(key: string, callback: SimpleCallback): void;
-export declare function removeKeyUpListenes(key: string): void;
+export declare function removeKeyUpListener(key: string, callback: SimpleCallback): void;
+export declare function removeKeyUpListeners(key: string): void;
 export declare function addMouseWheelUpListener(callback: SimpleCallback): void;
+export declare function removeMouseWheelUpListener(callback: SimpleCallback): void;
 export declare function removeMouseWheelUpListeners(): void;
 export declare function addMouseWheelDownListener(callback: SimpleCallback): void;
+export declare function removeMouseWheelDownListener(callback: SimpleCallback): void;
 export declare function removeMouseWheelDownListeners(): void;
 export declare function addExitListener(callback: SimpleCallback): void;
+export declare function removeExitListener(callback: SimpleCallback): void;
 export declare function removeExitListeners(): void;
 export declare function addMouseMoveListener(callback: MouseMoveCallback): void;
+export declare function removeMouseMoveListener(callback: MouseMoveCallback): void;
 export declare function removeMouseMoveListeners(): void;
 export declare function bindWS(ws: WebSocket): void;
 export {};

dist/KeyListenersManager.js

@@ -15,2 +15,11 @@ "use strict";
 }
+function removeCommandListener(cmd, callback) {
+    const listeners = keyDownListeners.get(cmd);
+    if (!listeners)
+        return;
+    const idx = listeners.indexOf(callback);
+    if (idx < 0)
+        return;
+    listeners.splice(idx, 1);
+}
 function removeCommandListeners(cmd) {
@@ -23,2 +32,6 @@ keyDownListeners.delete(cmd);
 exports.addKeyDownListener = addKeyDownListener;
+function removeKeyDownListener(key, callback) {
+    removeCommandListener({ type: "keyDown", key }, callback);
+}
+exports.removeKeyDownListener = removeKeyDownListener;
 function removeKeyDownListeners(key) {
@@ -32,6 +45,10 @@ removeCommandListeners({ type: "keyDown", key });
 exports.addKeyUpListener = addKeyUpListener;
-function removeKeyUpListenes(key) {
+function removeKeyUpListener(key, callback) {
+    removeCommandListener({ type: "keyUp", key }, callback);
+}
+exports.removeKeyUpListener = removeKeyUpListener;
+function removeKeyUpListeners(key) {
     removeCommandListeners({ type: "keyUp", key });
 }
-exports.removeKeyUpListenes = removeKeyUpListenes;
+exports.removeKeyUpListeners = removeKeyUpListeners;
 function addMouseWheelUpListener(callback) {
@@ -41,2 +58,6 @@ addCommandListener({ type: "mouseWheelUp" }, callback);
 exports.addMouseWheelUpListener = addMouseWheelUpListener;
+function removeMouseWheelUpListener(callback) {
+    removeCommandListener({ type: "mouseWheelUp" }, callback);
+}
+exports.removeMouseWheelUpListener = removeMouseWheelUpListener;
 function removeMouseWheelUpListeners() {
@@ -50,2 +71,6 @@ removeCommandListeners({ type: "mouseWheelUp" });
 exports.addMouseWheelDownListener = addMouseWheelDownListener;
+function removeMouseWheelDownListener(callback) {
+    removeCommandListener({ type: "mouseWheelDown" }, callback);
+}
+exports.removeMouseWheelDownListener = removeMouseWheelDownListener;
 function removeMouseWheelDownListeners() {
@@ -59,2 +84,6 @@ removeCommandListeners({ type: "mouseWheelDown" });
 exports.addExitListener = addExitListener;
+function removeExitListener(callback) {
+    removeCommandListener({ type: "exit" }, callback);
+}
+exports.removeExitListener = removeExitListener;
 function removeExitListeners() {
@@ -68,2 +97,9 @@ removeCommandListeners({ type: "exit" });
 exports.addMouseMoveListener = addMouseMoveListener;
+function removeMouseMoveListener(callback) {
+    const idx = mouseMoveListeners.indexOf(callback);
+    if (idx < 0)
+        return;
+    mouseMoveListeners.splice(idx, 1);
+}
+exports.removeMouseMoveListener = removeMouseMoveListener;
 function removeMouseMoveListeners() {
@@ -70,0 +106,0 @@ mouseMoveListeners = [];

dist/scratch.js

@@ -7,5 +7,6 @@ "use strict";
 });
-index_1.addKeyDownListener('f3', function () {
+function handleF3() {
     console.log('f3');
-});
+}
+index_1.addKeyDownListener(index_1.KEY_F3, handleF3);
 index_1.addMouseWheelUpListener(function () {
@@ -16,6 +17,9 @@ console.log('up');
     console.log('down');
+    console.log('f3 listener unregistered');
+    index_1.removeKeyDownListener(index_1.KEY_F3, handleF3);
 });
-index_1.addMouseMoveListener(function (x, y) {
-    console.log(x, y);
-});
+// addMouseMoveListener(function(x, y) {
+//     console.log(x, y);
+// });
+index_1.initKeyboardListener();
 //# sourceMappingURL=scratch.js.map

package.json

 {
   "name": "browser-forward-keyboard-listener",
   "description": "capture mouse and keyboard event from browser and send them back via WS",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "private": false,
@@ -19,4 +19,3 @@ "main": "dist/index.js",
     "ts-json-key-map": "^1.0.0",
-    "ws": "^6.1.0",
-    "opn": "^5.4.0"
+    "ws": "^6.1.0"
   },
@@ -23,0 +22,0 @@ "devDependencies": {

src/index.ts

 import {createServer} from "./server";
-import opn = require("opn");
 
@@ -4,0 +3,0 @@ export * from "./KeyListenersManager";

src/KeyListenersManager.ts

@@ -38,2 +38,11 @@ import * as WebSocket from "ws";
 
+function removeCommandListener(cmd:Message, callback:SimpleCallback) {
+    const listeners = keyDownListeners.get(cmd);
+    if(!listeners) return;
+    const idx = listeners.indexOf(callback);
+    if(idx < 0) return;
+
+    listeners.splice(idx, 1);
+}
+
 function removeCommandListeners(cmd:Message) {
@@ -46,2 +55,5 @@ keyDownListeners.delete(cmd);
 }
+export function removeKeyDownListener(key:string, callback:SimpleCallback) {
+    removeCommandListener({type:"keyDown",key}, callback);
+}
 export function removeKeyDownListeners(key:string) {
@@ -53,3 +65,6 @@ removeCommandListeners({type:"keyDown",key})
 }
-export function removeKeyUpListenes(key:string) {
+export function removeKeyUpListener(key:string, callback:SimpleCallback) {
+    removeCommandListener({type:"keyUp",key}, callback);
+}
+export function removeKeyUpListeners(key:string) {
     removeCommandListeners({type:"keyUp",key})
@@ -60,2 +75,5 @@ }
 }
+export function removeMouseWheelUpListener(callback:SimpleCallback) {
+    removeCommandListener({type:"mouseWheelUp"}, callback);
+}
 export function removeMouseWheelUpListeners() {
@@ -67,2 +85,5 @@ removeCommandListeners({type:"mouseWheelUp"});
 }
+export function removeMouseWheelDownListener(callback:SimpleCallback) {
+    removeCommandListener({type: "mouseWheelDown"}, callback);
+}
 export function removeMouseWheelDownListeners() {
@@ -74,2 +95,5 @@ removeCommandListeners({type: "mouseWheelDown"});
 }
+export function removeExitListener(callback:SimpleCallback) {
+    removeCommandListener({type:"exit"}, callback);
+}
 export function removeExitListeners() {
@@ -81,2 +105,7 @@ removeCommandListeners({type: "exit"});
 }
+export function removeMouseMoveListener(callback:MouseMoveCallback) {
+    const idx = mouseMoveListeners.indexOf(callback);
+    if(idx < 0) return;
+    mouseMoveListeners.splice(idx, 1);
+}
 export function removeMouseMoveListeners() {
@@ -83,0 +112,0 @@ mouseMoveListeners = []

src/scratch.ts

@@ -7,3 +7,4 @@ import {
     addMouseMoveListener,
-    addExitListener
+    addExitListener, removeKeyDownListener,
+    initKeyboardListener, KEY_F3
 } from "./index";
@@ -15,5 +16,8 @@
 
-addKeyDownListener('f3', function() {
+function handleF3() {
     console.log('f3');
-});
+}
+
+addKeyDownListener(KEY_F3, handleF3);
+
 addMouseWheelUpListener(function() {
@@ -25,6 +29,10 @@ console.log('up');
     console.log('down');
+    console.log('f3 listener unregistered');
+    removeKeyDownListener(KEY_F3, handleF3);
 });
 
-addMouseMoveListener(function(x, y) {
-    console.log(x, y);
-});
+// addMouseMoveListener(function(x, y) {
+//     console.log(x, y);
+// });
+
+initKeyboardListener();

No alert changes

Improved metrics

Total package byte prevSize

58133

8.73%

Dependency count

7

-12.5%

Lines of code

938

8.94%

Dependency changes

• - Removed

  opn@^5.4.0

• - Removed

  is-wsl@1.1.0
  (transitive)

• - Removed

  opn@5.5.0
  (transitive)