feat: Stabilize Deno.connect for 'unix' transport (#21937)

1 files changed, 25 insertions, 0 deletions

diff --git a/ext/net/lib.deno_net.d.ts b/ext/net/lib.deno_net.d.ts
index 64744b19e..e77b1bc6f 100644
--- a/ext/net/lib.deno_net.d.ts
+++ b/ext/net/lib.deno_net.d.ts
@@ -224,9 +224,34 @@ declare namespace Deno {
   }
 
   /** @category Network */
+  export interface UnixConnectOptions {
+    transport: "unix";
+    path: string;
+  }
+
+  /** @category Network */
   // deno-lint-ignore no-empty-interface
   export interface UnixConn extends Conn {}
 
+  /** Connects to the hostname (default is "127.0.0.1") and port on the named
+   * transport (default is "tcp"), and resolves to the connection (`Conn`).
+   *
+   * ```ts
+   * const conn1 = await Deno.connect({ port: 80 });
+   * const conn2 = await Deno.connect({ hostname: "192.0.2.1", port: 80 });
+   * const conn3 = await Deno.connect({ hostname: "[2001:db8::1]", port: 80 });
+   * const conn4 = await Deno.connect({ hostname: "golang.org", port: 80, transport: "tcp" });
+   * const conn5 = await Deno.connect({ path: "/foo/bar.sock", transport: "unix" });
+   * ```
+   *
+   * Requires `allow-net` permission for "tcp" and `allow-read` for "unix".
+   *
+   * @tags allow-net, allow-read
+   * @category Network
+   */
+  // deno-lint-ignore adjacent-overload-signatures
+  export function connect(options: UnixConnectOptions): Promise<UnixConn>;
+
   /** @category Network */
   export interface ConnectTlsOptions {
     /** The port to connect to. */