server-destroy

What is server-destroy?

The server-destroy npm package provides a simple way to add a destroy method to a Node.js HTTP server, allowing for the immediate termination of all active connections. This is particularly useful for gracefully shutting down servers during development or in production environments.

What are server-destroy's main functionalities?

Add destroy method to server

This feature allows you to add a destroy method to a Node.js HTTP server. The code sample demonstrates how to create an HTTP server, enable the destroy method, and then destroy the server after 5 seconds.

const http = require('http');
const enableDestroy = require('server-destroy');

const server = http.createServer((req, res) => {
  res.end('Hello, world!');
});

// Enable the destroy method on the server
enableDestroy(server);

server.listen(3000, () => {
  console.log('Server is listening on port 3000');
});

// Destroy the server after 5 seconds
setTimeout(() => {
  server.destroy(() => {
    console.log('Server destroyed');
  });
}, 5000);

Other packages similar to server-destroy

graceful-server

The graceful-server package provides a way to gracefully shut down a Node.js server by handling open connections and requests. Unlike server-destroy, which immediately terminates all connections, graceful-server allows for a more controlled shutdown process, ensuring that ongoing requests are completed before the server is closed.

http-terminator

The http-terminator package offers a way to gracefully terminate HTTP and HTTPS servers in Node.js. It ensures that all active connections are properly closed before shutting down the server. Compared to server-destroy, http-terminator provides more options for handling ongoing requests and connections, making it a more flexible solution for graceful shutdowns.

README

server-destroy

Enable destroying a server, and all currently open connections.

Usage

var enableDestroy = require('server-destroy');

var server = http.createServer(function(req, res) {
  // do stuff, blah blah blah
});

server.listen(PORT);

// enhance with a 'destroy' function
enableDestroy(server);

// some time later...
server.destroy();