Skip to content

Commit

Permalink
add undocumented reconnect option to API.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dwelle authored Aug 9, 2018
1 parent 2196c30 commit 1ae3b0a
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions API.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ Connects the client to the server where:
configured for `'direct'` type authentication, the value is the credentials expected
by the server for the specified authentication strategy used which typically means an
object with headers (e.g. `{ headers: { authorization: 'Basic am9objpzZWNyZXQ=' } }`).
- `reconnect` - a boolean that indicates whether the client should try to reconnect. Defaults to `true`.
- `delay` - time in milliseconds to wait between each reconnection attempt. The delay time
is cumulative, meaning that if the value is set to `1000` (1 second), the first wait will
be 1 seconds, then 2 seconds, 3 seconds, until the `maxDelay` value is reached and then
Expand Down

0 comments on commit 1ae3b0a

Please sign in to comment.