gracy

Gracy

Gracy is a zero-dependency library that provides a simple way to execute custom functions before a Node.js process exits. It helps you ensure that your applications perform cleanup tasks, gracefully close resources, and maintain data integrity during (un)expected shutdowns or terminations.

Usage

pnpm i gracy

import { onExit } from 'gracy'

onExit(
  { logger: pinoInstance },
  // Supports sync/async functions
  closeHttpServer,
  closeDatabaseConnection
)

Configuration

The onExit function accepts an configuration object as its first argument. The following options are available:

Name	Default value	Description
logger		Logger to use. You should use libraries for structured logging such as pino, but you can also use the built-in console object. Set to false to disable logging.
events	['uncaughtException', 'unhandledRejection']	Events to listen to. Triggering these events will cause the process to exit with code 1.
signals	['SIGTERM', 'SIGINT']	Signals to listen to. Triggering these signals will cause the process to exit with code 0.

Stack

This project has been scaffolded with create-npm-library.

License

MIT