Correct net.createServer() API docs
authorkoichik <koichik@improvement.jp>
Wed, 2 Mar 2011 18:32:13 +0000 (03:32 +0900)
committerRyan Dahl <ry@tinyclouds.org>
Wed, 2 Mar 2011 20:10:36 +0000 (12:10 -0800)
doc/api/net.markdown

index 6c67666..a4af6db 100644 (file)
@@ -4,11 +4,16 @@ The `net` module provides you with an asynchronous network wrapper. It contains
 methods for creating both servers and clients (called streams). You can include
 this module with `require("net");`
 
-### net.createServer(connectionListener)
+### net.createServer([options], [connectionListener])
 
 Creates a new TCP server. The `connectionListener` argument is
 automatically set as a listener for the `'connection'` event.
 
+`options` is an object with the following defaults:
+
+    { allowHalfOpen: false
+    }
+
 ### net.createConnection(arguments...)
 
 Construct a new socket object and opens a socket to the given location. When