Skip to content
Synkro

Graceful Shutdown

When your application shuts down, you want to finish processing in-flight events before disconnecting from the transport. Synkro provides a stop() method that handles this.

How it works

  1. Clear scheduled timers — all delayed and recurring schedules are cancelled immediately.
  2. Wait for in-flight handlers — Synkro polls for active handler and workflow executions until they complete or the drain timeout is reached.
  3. Disconnect — the transport connection (Redis) is closed.
await synkro.stop();

Drain timeout

The drainTimeout option controls how long stop() waits for in-flight handlers before forcing a disconnect. The default is 5000ms (5 seconds).

const synkro = await Synkro.start({
  transport: "redis",
  connectionUrl: "redis://localhost:6379",
  drainTimeout: 10000, // wait up to 10 seconds
});

If handlers are still running when the timeout is reached, Synkro logs a warning and disconnects anyway.

Process signal handlers

Use stop() in response to SIGTERM and SIGINT to shut down gracefully in production:

import { Synkro } from "@synkro/core";


const synkro = await Synkro.start({
  transport: "redis",
  connectionUrl: process.env.REDIS_URL,
});


async function shutdown() {
  console.log("Shutting down...");
  await synkro.stop();
  process.exit(0);
}


process.on("SIGTERM", shutdown);
process.on("SIGINT", shutdown);