Skip to content

feat(ws): Enable addEventListener/removeEventListener to Work with Unions of Event Types #70024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
typescript-bot merged 1 commit into from
Jul 13, 2024
Merged

feat(ws): Enable addEventListener/removeEventListener to Work with Unions of Event Types #70024

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 13 additions & 22 deletions types/ws/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,32 +112,16 @@ declare class WebSocket extends EventEmitter {
resume(): void;

// HTML5 WebSocket events
addEventListener(
method: "message",
cb: (event: WebSocket.MessageEvent) => void,
addEventListener<K extends keyof WebSocket.WebSocketEventMap>(
type: K,
listener: (event: WebSocket.WebSocketEventMap[K]) => void,
options?: WebSocket.EventListenerOptions,
): void;
addEventListener(
method: "close",
cb: (event: WebSocket.CloseEvent) => void,
options?: WebSocket.EventListenerOptions,
): void;
addEventListener(
method: "error",
cb: (event: WebSocket.ErrorEvent) => void,
options?: WebSocket.EventListenerOptions,
): void;
addEventListener(
method: "open",
cb: (event: WebSocket.Event) => void,
options?: WebSocket.EventListenerOptions,
removeEventListener<K extends keyof WebSocket.WebSocketEventMap>(
type: K,
listener: (event: WebSocket.WebSocketEventMap[K]) => void,
): void;

removeEventListener(method: "message", cb: (event: WebSocket.MessageEvent) => void): void;
removeEventListener(method: "close", cb: (event: WebSocket.CloseEvent) => void): void;
removeEventListener(method: "error", cb: (event: WebSocket.ErrorEvent) => void): void;
removeEventListener(method: "open", cb: (event: WebSocket.Event) => void): void;

// Events
on(event: "close", listener: (this: WebSocket, code: number, reason: Buffer) => void): this;
on(event: "error", listener: (this: WebSocket, err: Error) => void): this;
Expand Down Expand Up @@ -307,6 +291,13 @@ declare namespace WebSocket {
target: WebSocket;
}

interface WebSocketEventMap {
open: Event;
error: ErrorEvent;
close: CloseEvent;
message: MessageEvent;
}

interface EventListenerOptions {
once?: boolean | undefined;
}
Expand Down
15 changes: 8 additions & 7 deletions types/ws/ws-tests.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,17 +201,18 @@ import * as wslib from "ws";
const ws = new WebSocket("ws://www.host.com/path");
// @ts-expect-error
ws.addEventListener("other", () => {});
// @ts-expect-error
ws.removeEventListener("other", () => {});
}

{
const ws = new WebSocket("ws://www.host.com/path");
ws.addEventListener(
"message",
(event: WebSocket.MessageEvent) => {
console.log(event.data, event.target, event.type);
},
{ once: true },
);
const listener = (event: WebSocket.MessageEvent) => console.log(event.data, event.target, event.type);
ws.addEventListener("message", listener, { once: true });
ws.removeEventListener("message", listener);

ws.addEventListener("open" as "open" | "close" | "error" | "message", console.log);
ws.removeEventListener("open" as "open" | "close" | "error" | "message", console.log);
}

{
Expand Down