@bufferapp/shutdown-helper
Provides a basic helper that listens to the SIGTERM
signal and will shutdown the given
Express.js server after the given delay in seconds.
Install
npm install @bufferapp/shutdown-helper -SE
Usage
To use with your Express.js app, you'll have to use Node's http
package to start your server.
Here is a full usage example:
const http = const express = const shutdownHelper = const createLogger = const shutdownDelay = 20 // seconds const logger = const app = const server = http server shutdownHelper
The init
function takes one argument with the following options:
server
(http.Server) - An instance of a Node http servershutdownDelay
(Integer) - The delay in seconds after which to shut down the http server. Default20
seconds.logger
(@bufferapp/logger) - (optional) - If passed in log messages to@bufferapp/logger
otherwise logged toconsole
Elsewhere in your application, ideally in a health-check endpoint, you can use the isShutingDown
function to check if your application has received a SIGTERM
:
const isShutingDown = app