@scdev/fine NPM

fine

"Fine" means "End" in Italian, fì-ne Cessazione definitiva, punto estremo, nello spazio e nel tempo di qualcosa.

About

Zero dependency and opinionated package that gracefully shutdown Node.js applications.

It provides extendability by taking an array of callbacks that will be executed serially to allow closing user-defined resources, eg: a database connection, drain streams, etc; before timeout exits the main process.

Installation
Usage
- Arguments
Contributing
License
Contact

Installation

You can install locally

npm i @scdev/fine

Usage

// Example
const http = require("http");
const { promisify } = require("util");
const fine = require("@scdev/fine");

const server = http.createServer(/* your handler */);

fine(
  [
    // Tip: you can wait that all connection are closed
    promisify(server.close),
    // or you can just sto accepting new one and continue closing other callbacks
    server.close,

    async () => {
      // Throws will be NOOP-ed
      await db.disconnect();
    },
  ],
  {
    timeout: 2000,
    events: ["SIGINT", "SIGTERM", "uncaughtException", "unhandledRejection"],
  }
);

// ...

Arguments

fine(callbacks, options);

parameter	type	description	default
`callbacks`	function[]	Collection of callback for custom closing events, eg: db.disconnect()	`[]`
`options.timeout`	Number	The time before exiting the process	`2000`
`options.events`	string[]	The events the process will listen on	`["SIGINT", "SIGTERM", "uncaughtException", "unhandledRejection"]`
`options.unref`	boolean	Should the timeout keep the process alive or not	`false`