Permalink
Browse files

document "connect" event with link to docs for net

  • Loading branch information...
1 parent 0949eaf commit 729e22aaacc68d75003ba1951da0e52f01315840 @dominictarr dominictarr committed Aug 15, 2012
Showing with 4 additions and 2 deletions.
  1. +4 −2 README.markdown
View
6 README.markdown
@@ -171,8 +171,10 @@ var stream = shoe(uri, cb)
Return a readable/writable stream from the sockjs path `uri`.
`uri` may be a full uri or just a path.
-`cb()` will fire when the stream is actually open, but writes will be buffered
-before then.
+`shoe` will emit a `'connect'` event when the connection is actually open,
+(just like in [net](http://nodejs.org/api/net.html#net_net_connect_options_connectionlistener)).
+writes performed before the `'connect'` event will be buffered. passing in `cb` to
+shoe is a shortcut for `shoe(uri).on('connect', cb)`
server methods
==============

0 comments on commit 729e22a

Please sign in to comment.