graceful-shutdown
Shuts down a Server
gracefully upon the first specified signal received by the process and executes the optional callback.
example
var gracefullyShutdown = ; var server = http; ;
documentation
constructor
graceful-shutdown
exports a single constructor. It may be called with or without the new
keyword.
var GracefulShutdown = ; // these are the same:var gs = ;var gs = server;
The constructor accepts a single net.Server
instance.
GracefulShutdown#upon()
Accepts either a space delimited list of events or an array of event names. Listeners for these events will be added to the process
. Once any one of these events are emitted on the process
, server.close()
will be executed, and all registered event listeners will be removed.
// these are the samevar gs = ;var gs = ;
Events
The GracefulShutdown instance will emit a shutting-down
event when server.close()
has been called.
Note, this is not a listener for the server close event. If you want to listen for the server close
event you must add the listener yourself.
; server;
An alternative way to register a callback for the shutting-down
event is to pass it as the second argument to GracefulShutdown.
;
install
npm install graceful-shutdown
License
MIT