FINIS

!Finis

Run your callback before node exit, pass exit code and signal name as arguments

INSTALLATION

``shell
npm install finis --save
`

USAGE

finis() installs a callback function which will be run just before the node process exits.

The callback function will be called when:

1. the process exits normally
1. the user presses _Ctrl+C_
1. an exception is uncaught

EXAMPLE

$3

`js
const finis = require('finis')

finis((code, signal, error) => {
console.log(finis(${code}, ${signal}, ${error}))
})
`

$3

`ts
import finis from 'finis'

finis((code: number, signal: 'exit'|'SIGINT'|'SIGTERM'|'uncaughtException', error?: Error) => {
console.log(finis(${code}, ${signal}, ${error}))
})
`

You may call finis() multiple times to install multiple callback functions.

CHANGELOG

$3

1. Do not call process.exit by default
1. Add support to SIGTERM`
1. Add support to TypeScript

$3

This module is inspired by @jtlapp/node-cleanup, which is borrowed and modified from CanyonCasa's answer to a stackoverflow question. I found the code necessary for all my node projects. See the stackoverflow answer for more examples of use.

MAINTAINER

Huan LI \ ()

COPYRIGHT & LICENSE

* Code & Docs © 2016-2017 Huan LI \
* Code released under the Apache-2.0 License
* Docs released under Creative Commons