Skip to main content

setTimeout

method Server.prototype.setTimeout
Jump to headingServer.prototype.setTimeout(
msecs?: number,
callback?: () => void,
): this

Sets the timeout value for sockets, and emits a 'timeout' event on the Server object, passing the socket as an argument, if a timeout occurs.

If there is a 'timeout' event listener on the Server object, then it will be called with the timed-out socket as an argument.

By default, the Server does not timeout sockets. However, if a callback is assigned to the Server's 'timeout' event, timeouts must be handled explicitly.

Parameters Jump to heading

optional
Jump to headingmsecs: number = 0 (no timeout)
optional
Jump to headingcallback: () => void

Return Type Jump to heading

this
Jump to headingServer.prototype.setTimeout(callback: () => void): this

Parameters Jump to heading

Jump to headingcallback: () => void

Return Type Jump to heading

this
Back to top