Skip to content

Commit

Permalink
Updates to the documentation
Browse files Browse the repository at this point in the history
Description of valid fields in the options object.
  • Loading branch information
ahhentz committed Sep 23, 2011
1 parent 3836f37 commit 072b650
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,31 @@ wire.
Returns `this` so you can chain middlewares.
the options object
==================
You can pass an options object to the methods `connect()` and `listen()`. Valid
fields for this object are:
* `host` is the host to connect (client) or listen (server)
* `port` is the port to connect (client) or listen (server)
* `path` is the path to a Unix domain socket to connect (client) or listen (server)
* `reconnect` (for clients): time to wait between reconnections
* `key` private key for TLS streams (required for encrypted communication)
* `cert` certificate for TLS streams (required for servers)
* `ca` list of trusted certificates
* `requestCert` (for servers) `true` to request client certificates
* `rejectUnauthorized` (for servers) `true` to terminate connections with
no or invalid certificates
the connection object
=====================
Expand Down

0 comments on commit 072b650

Please sign in to comment.