Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Save koichik/851431 to your computer and use it in GitHub Desktop.
Save koichik/851431 to your computer and use it in GitHub Desktop.
Correct net.createServer() API docs
From d6f66f508052f2108633190c4a149c1131dc87fc Mon Sep 17 00:00:00 2001
From: koichik <koichik@improvement.jp>
Date: Thu, 3 Mar 2011 03:32:13 +0900
Subject: [PATCH] Correct net.createServer() API docs
---
doc/api/net.markdown | 7 ++++++-
1 files changed, 6 insertions(+), 1 deletions(-)
diff --git a/doc/api/net.markdown b/doc/api/net.markdown
index 6c67666..a4af6db 100644
--- a/doc/api/net.markdown
+++ b/doc/api/net.markdown
@@ -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
--
1.7.1
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment