Skip to content

Commit 7468a39

Browse files
committed
Add documentation for retryCount and retryDelay options.
1 parent b664055 commit 7468a39

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

docs/API.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Client
3131
floodProtection: false,
3232
floodProtectionDelay: 1000,
3333
sasl: false,
34+
retryCount: 0,
35+
retryDelay: 2000,
3436
stripColors: false,
3537
channelPrefixes: "&#",
3638
messageSplit: 512,
@@ -77,6 +79,9 @@ Client
7779
var client = new irc.Client({ autoConnect: false, ... });
7880
client.connect();
7981

82+
`retryCount` is the number of times the client will try to automatically reconnect when disconnected. It defaults to 0.
83+
84+
`retryDelay` is the number of milliseconds to wait before retying to automatically reconnect when disconnected. It defaults to 2000.
8085

8186
.. js:function:: Client.send(command, arg1, arg2, ...)
8287

0 commit comments

Comments
 (0)