Skip to main content

setTimeout

method Socket.prototype.setTimeout
Jump to headingSocket.prototype.setTimeout(
timeout: number,
callback?: () => void,
): this

Sets the socket to timeout after timeout milliseconds of inactivity on the socket. By default net.Socket do not have a timeout.

When an idle timeout is triggered the socket will receive a 'timeout' event but the connection will not be severed. The user must manually call socket.end() or socket.destroy() to end the connection.

socket.setTimeout(3000);
socket.on('timeout', () => {
  console.log('socket timeout');
  socket.end();
});

If timeout is 0, then the existing idle timeout is disabled.

The optional callback parameter will be added as a one-time listener for the 'timeout' event.

Parameters Jump to heading

Jump to headingtimeout: number
optional
Jump to headingcallback: () => void

Return Type Jump to heading

this

The socket itself.

Back to top