Add types for once/off/removeListener (#43170)

DefinitelyTyped · Mar 18, 2020 · 4bf2352 · 4bf2352
1 parent ab406a4
commit 4bf2352
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 3 deletions.
diff --git a/types/ws/index.d.ts b/types/ws/index.d.ts
@@ -238,11 +238,29 @@ declare namespace WebSocket {
         on(event: 'close' | 'listening', cb: (this: Server) => void): this;
         on(event: string | symbol, listener: (this: Server, ...args: any[]) => void): this;
 
+        once(event: 'connection', cb: (this: Server, socket: WebSocket, request: http.IncomingMessage) => void): this;
+        once(event: 'error', cb: (this: Server, error: Error) => void): this;
+        once(event: 'headers', cb: (this: Server, headers: string[], request: http.IncomingMessage) => void): this;
+        once(event: 'close' | 'listening', cb: (this: Server) => void): this;
+        once(event: string | symbol, listener: (...args: any[]) => void): this;
+
+        off(event: 'connection', cb: (this: Server, socket: WebSocket, request: http.IncomingMessage) => void): this;
+        off(event: 'error', cb: (this: Server, error: Error) => void): this;
+        off(event: 'headers', cb: (this: Server, headers: string[], request: http.IncomingMessage) => void): this;
+        off(event: 'close' | 'listening', cb: (this: Server) => void): this;
+        off(event: string | symbol, listener: (this: Server, ...args: any[]) => void): this;
+
         addListener(event: 'connection', cb: (client: WebSocket) => void): this;
         addListener(event: 'error', cb: (err: Error) => void): this;
         addListener(event: 'headers', cb: (headers: string[], request: http.IncomingMessage) => void): this;
         addListener(event: 'close' | 'listening', cb: () => void): this;
         addListener(event: string | symbol, listener: (...args: any[]) => void): this;
+
+        removeListener(event: 'connection', cb: (client: WebSocket) => void): this;
+        removeListener(event: 'error', cb: (err: Error) => void): this;
+        removeListener(event: 'headers', cb: (headers: string[], request: http.IncomingMessage) => void): this;
+        removeListener(event: 'close' | 'listening', cb: () => void): this;
+        removeListener(event: string | symbol, listener: (...args: any[]) => void): this;
     }
 
     // WebSocket stream

diff --git a/types/ws/ws-tests.ts b/types/ws/ws-tests.ts
@@ -27,9 +27,11 @@ import * as url from 'url';
         ws.send('something', (error?: Error) => {});
         ws.send('something', {}, (error?: Error) => {});
     });
-
-    wss.on('upgrade', (res) => {
-        console.log(`response: ${Object.keys(res)}`);
+    wss.once('connection', (ws, req) => {
+        ws.send('something');
+    });
+    wss.off('connection', (ws, req) => {
+        ws.send('something');
     });
 }