gracy

Gracy

Execute custom cleanup functions before Node.js exits. Zero dependencies.

Usage

pnpm i gracy

import { onExit } from 'gracy'

onExit(
  { logger: pinoInstance },
  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.

• Node.js & Typescript (ESM)
• tsup for bundling
• pnpm package manager
• Vitest for testing (coverage via c8)
• Prettier formatter
• ESLint linter
• Husky Git hooks
• Changesets for versioning

License

MIT