Skip to content

Commit cb10d01

Browse files
docs: improve documentation for the autoUnref option
1 parent 156d622 commit cb10d01

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

lib/socket.ts

+3-2
Original file line numberDiff line numberDiff line change
@@ -183,8 +183,9 @@ export interface SocketOptions {
183183
useNativeTimers: boolean;
184184

185185
/**
186-
* weather we should unref the reconnect timer when it is
187-
* create automatically
186+
* Whether the heartbeat timer should be unref'ed, in order not to keep the Node.js event loop active.
187+
*
188+
* @see https://nodejs.org/api/timers.html#timeoutunref
188189
* @default false
189190
*/
190191
autoUnref: boolean;

0 commit comments

Comments
 (0)