Skip to content

Commit

Permalink
documented bounce() returning a stream
Browse files Browse the repository at this point in the history
  • Loading branch information
James Halliday committed Oct 24, 2011
1 parent aef769c commit 086f137
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 3 additions & 0 deletions README.markdown
Expand Up @@ -93,6 +93,9 @@ If you pass in an emitter you'll get the connection object on `"drop"` events so
you can handle these yourself by writing an error message to the stream. If you
don't pass in an `opts.emitter`, the connection will be `.destroy()`ed.

`bounce()` returns the stream object that it's using. This is useful if you pass
in a port so you can `.on('error', fn)` to detect connection errors.

bounce(port, ...), bounce(host, port, ...)
------------------------------------------

Expand Down
2 changes: 1 addition & 1 deletion package.json
@@ -1,7 +1,7 @@
{
"name" : "bouncy",
"description" : "Bounce HTTP requests around for a load balancer or http host router completely transparently",
"version" : "1.0.0",
"version" : "1.0.1",
"repository" : {
"type" : "git",
"url" : "git://github.com/substack/bouncy.git"
Expand Down

0 comments on commit 086f137

Please sign in to comment.