Skip to content

Commit

Permalink
fix: document new option in README
Browse files Browse the repository at this point in the history
  • Loading branch information
mgabeler-lee-6rs committed Oct 16, 2024
1 parent 6f207c7 commit fcccb81
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,13 @@ the final connection when it drops.
The default value is 1000 ms which means it will try to reconnect 1 second
after losing the connection.

Note that this will only enable reconnects after either a connection timeout, or
after a successful connection. It will _not_ (by default) enable retrying
connections that are actively denied with a CONNACK error by the server.

To also enable automatic reconnects for CONNACK errors, set
`reconnectOnConnackError: true`.

<a name="topicalias"></a>

## About Topic Alias Management
Expand Down Expand Up @@ -415,6 +422,8 @@ The arguments are:
offline
- `reconnectPeriod`: `1000` milliseconds, interval between two
reconnections. Disable auto reconnect by setting to `0`.
- `reconnectOnConnackError`: `false`, whether to also reconnect if a CONNACK
is received with an error.
- `connectTimeout`: `30 * 1000` milliseconds, time to wait before a
CONNACK is received
- `username`: the username required by your broker, if any
Expand Down

0 comments on commit fcccb81

Please sign in to comment.