Documentation for connection.connect()

nodejs · Jun 5, 2009 · 5170823 · 5170823
1 parent 6e4e228
commit 5170823
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/website/api.html b/website/api.html
@@ -421,6 +421,13 @@ <h3 id="tcp_connection"><code>node.tcp.Connection</code></h3>
     <dt><code>new node.tcp.Connection()</code></dt>
     <dd>Creates a new connection object.</dd>
 
+    <dt><code>connection.connect(port, host="127.0.0.1")</code></dt>
+    <dd>
+      Opens a connection to the specified <code>port</code> and
+      <code>host</code>. If the second parameter is omitted, localhost is
+      assumed. 
+    </dd>
+
     <dt><code>connection.readyState</code></dt>
     <dd>
       Either <code>"closed"</code>, <code>"open"</code>,