Permalink
Browse files

documented free() object parameters

  • Loading branch information...
1 parent 6388685 commit 5357b872cd21a37651bc3223097cabda7873cb66 @substack committed Mar 23, 2012
Showing with 4 additions and 0 deletions.
  1. +4 −0 README.markdown
View
@@ -149,6 +149,10 @@ ports.free(port, cb)
Give a port back. `cb(alloc)` fires when complete. You will get back the `alloc`
object that you would have gotten if you'd queried the service directly.
+If `port` is an object, you can free ports on other services besides the
+presently connected host by passing in a `host` field in addition to a `port`
+field.
+
ports.assume(role, port or meta={}, cb)
---------------------------------------

0 comments on commit 5357b87

Please sign in to comment.