server-terminate

server-terminate

Allow terminating an HTTP server in an orderly fashion:

• Immediately closes keep-alive connections that are not being used by any HTTP request.
• Waits for running HTTP requests to finish before closing their connections.
• Closes connections with running HTTP requests after a given timeout.

If you want to destroy all open connections without waiting for HTTP requests to finish, use the module server-destroy.

Installation

npm install server-terminate

Usage

var enableTerminate = require('server-terminate');
var http = require('http');

var server = http.createServer(function onRequest(req, res) {
  // Do your stuff here
});
enableTerminate(server).listen(PORT));


// When you want to stop your server...
server.terminate(function(err, terminatedByTimeout) {
  // You get here when all connections have been closed
});

Or if you are using TypeScript:

import * as http from 'http';
import enableTerminate from 'server-terminate';

let server: http.Server = http.createServer(function onRequest(req: http.ServerRequest, res: http.ServerResponse) {
    // Do your stuff here
});
enableTerminate(server).listen(PORT));

// When you want to stop your server...
server.terminate((err, terminatedByTimeout) => {
    // You get here when all connections have been closed
});

You can set a timeout to force connection closing even when they are still being used by running HTTP requests. It is measured in milliseconds and defaults to 30000.

enableTerminate(server, {timeout: 10000}).listen(PORT));

If the server terminates by timeout the second parameter of the callback will be true.

License

MIT

Changelog

1.3.0 (2016-09-01)

Features

• Add TypeScript declarations (resolves #2) (2e5ec03), closes #2
• Allow the terminate callback to signal whether the server has terminated by timeout (#1) (f684a4f)