summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTim Caswell <tim@creationix.com>2010-04-19 08:18:16 -0500
committerRyan Dahl <ry@tinyclouds.org>2010-04-19 15:52:51 -0700
commit61308a5bff0fe184744f5f6e9031991826b74796 (patch)
tree2d722f84e813720b72a27f6b4e0a015f21510757 /doc
parent60de86351ac9264845bc4033eb7e44b9b0c74c6d (diff)
downloadnode-new-61308a5bff0fe184744f5f6e9031991826b74796.tar.gz
Add a note in the API docs about binding to ports and using strings.
Diffstat (limited to 'doc')
-rw-r--r--doc/api.markdown2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/api.markdown b/doc/api.markdown
index 2f1abed6c2..274d8f611e 100644
--- a/doc/api.markdown
+++ b/doc/api.markdown
@@ -1485,6 +1485,8 @@ address.
To listen to a unix socket, supply a filename instead of port and hostname.
+**If you give a port number as a string, the system will interpret it as a filename in the current directory and create a unix socket.**
+
This function is asynchronous. `listening` will be emitted when the server
is ready to accept connections.