🤖 Merge PR DefinitelyTyped#74204 [w3c-direct-sockets] Refactor to use global classes and strict DOM maps. by @paulinagacek

Author: paulinagacek

types/w3c-direct-sockets/index.d.ts

@@ -2,11 +2,13 @@
  * @see https://github.com/WICG/direct-sockets/blob/main/docs/explainer.md
  */
 
-export class UDPSocket {
-    constructor(options: UDPSocketOptions);
-    readonly opened: Promise<UDPSocketOpenInfo>;
-    readonly closed: Promise<undefined>;
-    close(): Promise<undefined>;
+declare global {
+    class UDPSocket {
+        constructor(options: UDPSocketOptions);
+        readonly opened: Promise<UDPSocketOpenInfo>;
+        readonly closed: Promise<void>;
+        close(): Promise<void>;
+    }
 }
 
 export interface UDPMessage {
@@ -16,18 +18,22 @@ export interface UDPMessage {
     dnsQueryType?: SocketDnsQueryType;
 }
 
-export class TCPSocket {
-    constructor(remoteAddress: string, remotePort: number, options?: TCPSocketOptions);
-    readonly opened: Promise<TCPSocketOpenInfo>;
-    readonly closed: Promise<undefined>;
-    close(): Promise<undefined>;
+declare global {
+    class TCPSocket {
+        constructor(remoteAddress: string, remotePort: number, options?: TCPSocketOptions);
+        readonly opened: Promise<TCPSocketOpenInfo>;
+        readonly closed: Promise<void>;
+        close(): Promise<void>;
+    }
 }
 
-export class TCPServerSocket {
-    constructor(localAddress: string, options?: TCPServerSocketOptions);
-    readonly opened: Promise<TCPServerSocketOpenInfo>;
-    readonly closed: Promise<undefined>;
-    close(): Promise<undefined>;
+declare global {
+    class TCPServerSocket {
+        constructor(localAddress: string, options?: TCPServerSocketOptions);
+        readonly opened: Promise<TCPServerSocketOpenInfo>;
+        readonly closed: Promise<void>;
+        close(): Promise<void>;
+    }
 }
 
 export type SocketDnsQueryType =
@@ -85,8 +91,10 @@ export interface TCPServerSocketOpenInfo {
     localPort?: number;
 }
 
-export interface MulticastController {
-    joinGroup(ipAddress: string): Promise<undefined>;
-    leaveGroup(ipAddress: string): Promise<undefined>;
-    readonly joinedGroups: readonly string[];
+declare global {
+    interface MulticastController {
+        joinGroup(ipAddress: string): Promise<void>;
+        leaveGroup(ipAddress: string): Promise<void>;
+        readonly joinedGroups: readonly string[];
+    }
 }

types/w3c-direct-sockets/w3c-direct-sockets-tests.ts

@@ -1,14 +1,10 @@
 import {
-    MulticastController,
     SocketDnsQueryType,
-    TCPServerSocket,
     TCPServerSocketOpenInfo,
     TCPServerSocketOptions,
-    TCPSocket,
     TCPSocketOpenInfo,
     TCPSocketOptions,
     UDPMessage,
-    UDPSocket,
     UDPSocketOpenInfo,
     UDPSocketOptions,
 } from "w3c-direct-sockets";
@@ -52,10 +48,10 @@ async function testDirectSockets() {
     // $ExpectType Promise<UDPSocketOpenInfo>
     udpSocket.opened;
 
-    // $ExpectType Promise<undefined>
+    // $ExpectType Promise<void>
     udpSocket.closed;
 
-    // $ExpectType Promise<undefined>
+    // $ExpectType Promise<void>
     udpSocket.close();
 
     // Cast to 'any' or 'UDPMessage' to avoid "missing properties" error during test compilation
@@ -84,10 +80,10 @@ async function testDirectSockets() {
     // $ExpectType Promise<SocketOpenInfo>
     tcpSocket.opened;
 
-    // $ExpectType Promise<undefined>
+    // $ExpectType Promise<void>
     tcpSocket.closed;
 
-    // $ExpectType Promise<undefined>
+    // $ExpectType Promise<void>
     tcpSocket.close();
 
     // --------------------------------------------------------------------------------
@@ -107,10 +103,10 @@ async function testDirectSockets() {
     // $ExpectType Promise<TCPServerSocketOpenInfo>
     tcpServerSocket.opened;
 
-    // $ExpectType Promise<undefined>
+    // $ExpectType Promise<void>
     tcpServerSocket.closed;
 
-    // $ExpectType Promise<undefined>
+    // $ExpectType Promise<void>
     tcpServerSocket.close();
 
     // --------------------------------------------------------------------------------
@@ -144,9 +140,9 @@ async function testDirectSockets() {
     // $ExpectType readonly string[]
     multicastController.joinedGroups;
 
-    // $ExpectType Promise<undefined>
+    // $ExpectType Promise<void>
     multicastController.joinGroup(remoteAddress);
 
-    // $ExpectType Promise<undefined>
+    // $ExpectType Promise<void>
     multicastController.leaveGroup(remoteAddress);
 }