Skip to main content

Graceful Shutdown in Minimajs

Overview

Minimajs offers built-in support for graceful shutdown, ensuring applications terminate in a controlled and predictable manner when instructed to do so. This feature prevents abrupt terminations that could lead to data loss or inconsistencies.

Key Features:

  • Automatic SIGTERM Handling: By default, Minimajs listens for the SIGTERM signal, a common signal used to initiate process termination. Upon receiving this signal, it begins the graceful shutdown process.
  • Customizable Handling: You can adjust the shutdown behavior by:
    • Specifying additional signals to listen for using the killSignal option within createApp().
    • Disabling graceful shutdown entirely by passing an empty array [] to killSignal.
  • Lifecycle Hooks: Minimajs provides hooks to execute custom logic during specific lifecycle stages, such as cleaning up resources before shutdown:
    • app.addHook('onClose', () => closeDBConnection())

Example Configuration:

import { createApp } from "@minimajs/server";

// Listen for multiple signals, including SIGINT (Ctrl+C)
const app = createApp({
  killSignal: ["SIGTERM", "SIGINT"],
});

// Example hook for closing database connections
app.addHook("onClose", () => closeDBConnection());

app.listen({ port: 1234 });

Additional Considerations: