From: Josh Gummersall Date: Sat, 16 May 2015 19:27:03 +0000 (-0700) Subject: doc: fix connectListener description in net docs X-Git-Tag: v2.1.0~27 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=fbaef40e63ba1091156b8897f0ecd6aaf27bf4e2;p=platform%2Fupstream%2Fnodejs.git doc: fix connectListener description in net docs `connectListener` is registered as a listener to the 'connect' event once. Update the documentation to reflect that behavior. Fixes: https://github.com/nodejs/io.js/issues/901 PR-URL: https://github.com/nodejs/io.js/pull/1717 Reviewed-By: Ben Noordhuis --- diff --git a/doc/api/net.markdown b/doc/api/net.markdown index 3fc6cf8..a3a1134 100644 --- a/doc/api/net.markdown +++ b/doc/api/net.markdown @@ -67,8 +67,8 @@ The options are passed to both the ['net.Socket'](#net_class_net_socket) constructor and the ['socket.connect'](#net_socket_connect_options_connectlistener) method. -The `connectListener` parameter will be added as an listener for the -['connect'][] event. +The `connectListener` parameter will be added as a listener for the +['connect'][] event once. Here is an example of a client of the previously described echo server: @@ -100,8 +100,8 @@ supplied `port` and `host`. If `host` is omitted, `'localhost'` will be assumed. -The `connectListener` parameter will be added as an listener for the -['connect'][] event. +The `connectListener` parameter will be added as a listener for the +['connect'][] event once. ## net.connect(path[, connectListener]) ## net.createConnection(path[, connectListener]) @@ -110,8 +110,8 @@ A factory function, which returns a new unix ['net.Socket'](#net_class_net_socket) and automatically connects to the supplied `path`. -The `connectListener` parameter will be added as an listener for the -['connect'][] event. +The `connectListener` parameter will be added as a listener for the +['connect'][] event once. ## Class: net.Server