🤖 Merge PR DefinitelyTyped#72670 [node] Allow the err parameter to the net.Socket#write callback (in case of success) to be null as well as undefined by @jswalden

Author: jswalden

types/node/net.d.ts

@@ -109,8 +109,8 @@ declare module "net" {
          * @since v0.1.90
          * @param [encoding='utf8'] Only used when data is `string`.
          */
-        write(buffer: Uint8Array | string, cb?: (err?: Error) => void): boolean;
-        write(str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error) => void): boolean;
+        write(buffer: Uint8Array | string, cb?: (err?: Error | null) => void): boolean;
+        write(str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error | null) => void): boolean;
         /**
          * Initiate a connection on a given socket.
          *

types/node/test/net.ts

@@ -63,6 +63,9 @@ import * as net from "node:net";
     });
 
     let bool: boolean;
+    let uint8array: Uint8Array = new Uint8Array(0);
+    let bufferEncoding: BufferEncoding = "utf8";
+    let str = "123";
 
     bool = _socket.connecting;
     bool = _socket.destroyed;
@@ -76,6 +79,20 @@ import * as net from "node:net";
     _socket = _socket.resume();
     _socket = _socket.resetAndDestroy();
 
+    // write callback parameter can be either null/undefined or an error
+    bool = _socket.write(uint8array, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(str, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(uint8array, bufferEncoding, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(str, bufferEncoding, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+
     _socket = _socket.end();
     _socket = _socket.destroy();
     _socket.destroySoon();
@@ -132,6 +149,8 @@ import * as net from "node:net";
     let error = new Error("asd");
     let str = "123";
     let num = 123;
+    let uint8array: Uint8Array = new Uint8Array(0);
+    let bufferEncoding: BufferEncoding = "utf8";
 
     const ipcConnectOpts: net.IpcSocketConnectOpts = {
         path: "/",
@@ -370,6 +389,20 @@ import * as net from "node:net";
     _socket = _socket.prependOnceListener("ready", () => {});
     _socket = _socket.prependOnceListener("timeout", () => {});
 
+    // write callback parameter can be either null/undefined or an error
+    bool = _socket.write(uint8array, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(str, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(uint8array, bufferEncoding, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(str, bufferEncoding, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+
     _socket.destroy().destroy();
     _socket.readyState; // $ExpectType SocketReadyState
 }

types/node/v20/net.d.ts

@@ -112,8 +112,8 @@ declare module "net" {
          * @since v0.1.90
          * @param [encoding='utf8'] Only used when data is `string`.
          */
-        write(buffer: Uint8Array | string, cb?: (err?: Error) => void): boolean;
-        write(str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error) => void): boolean;
+        write(buffer: Uint8Array | string, cb?: (err?: Error | null) => void): boolean;
+        write(str: Uint8Array | string, encoding?: BufferEncoding, cb?: (err?: Error | null) => void): boolean;
         /**
          * Initiate a connection on a given socket.
          *

types/node/v20/test/net.ts

@@ -53,6 +53,9 @@ import * as net from "node:net";
     });
 
     let bool: boolean;
+    let uint8array: Uint8Array = new Uint8Array(0);
+    let bufferEncoding: BufferEncoding = "utf8";
+    let str = "123";
 
     bool = _socket.connecting;
     bool = _socket.destroyed;
@@ -66,6 +69,20 @@ import * as net from "node:net";
     _socket = _socket.resume();
     _socket = _socket.resetAndDestroy();
 
+    // write callback parameter can be either null/undefined or an error
+    bool = _socket.write(uint8array, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(str, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(uint8array, bufferEncoding, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(str, bufferEncoding, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+
     _socket = _socket.end();
     _socket = _socket.destroy();
     _socket.destroySoon();
@@ -122,6 +139,8 @@ import * as net from "node:net";
     let error = new Error("asd");
     let str = "123";
     let num = 123;
+    let uint8array: Uint8Array = new Uint8Array(0);
+    let bufferEncoding: BufferEncoding = "utf8";
 
     const ipcConnectOpts: net.IpcSocketConnectOpts = {
         path: "/",
@@ -360,6 +379,20 @@ import * as net from "node:net";
     _socket = _socket.prependOnceListener("ready", () => {});
     _socket = _socket.prependOnceListener("timeout", () => {});
 
+    // write callback parameter can be either null/undefined or an error
+    bool = _socket.write(uint8array, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(str, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(uint8array, bufferEncoding, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+    bool = _socket.write(str, bufferEncoding, (err) => {
+        if (err) { const _err: Error = err; }
+    });
+
     _socket.destroy().destroy();
     _socket.readyState; // $ExpectType SocketReadyState
 }