typings: add a few JSDoc typings for the net lib module

festiveelephantseal · targos · commit f206af679c22 · 2021-09-04T13:05:00.000+02:00
PR-URL: #38953 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com>
diff --git a/lib/net.js b/lib/net.js
@@ -161,6 +161,16 @@ function isPipeName(s) {
   return typeof s === 'string' && toNumber(s) === false;
 }
 
+/**
+ * Creates a new TCP or IPC server
+ * @param {{
+ *   allowHalfOpen?: boolean;
+ *   pauseOnConnect?: boolean;
+ *   }} [options]
+ * @param {Function} [connectionListener]
+ * @returns {Server}
+ */
+
 function createServer(options, connectionListener) {
   return new Server(options, connectionListener);
 }
@@ -1563,6 +1573,11 @@ function onconnection(err, clientHandle) {
   self.emit('connection', socket);
 }
 
+/**
+ * Gets the number of concurrent connections on the server
+ * @param {Function} cb
+ * @returns {Server}
+ */
 
 Server.prototype.getConnections = function(cb) {
   const self = this;
