@warlock.js/scheduler 5.24.0 → 5.25.0

package/package.json

@@ -8,7 +8,7 @@
     "dayjs": "^1.11.19"
   },
   "peerDependencies": {
-    "@warlock.js/cache": "5.24.0"
+    "@warlock.js/cache": "5.25.0"
   },
   "peerDependenciesMeta": {
     "@warlock.js/cache": {
@@ -33,7 +33,7 @@
   ],
   "author": "hassanzohdy",
   "license": "MIT",
-  "version": "5.24.0",
+  "version": "5.25.0",
   "main": "./cjs/index.cjs",
   "module": "./esm/index.mjs",
   "types": "./esm/index.d.mts",

package/skills/configure-retry-and-overlap/SKILL.md

@@ -1,152 +1,152 @@
----
-name: configure-retry-and-overlap
-description: 'Configure `.retry(maxRetries, delay?, backoffMultiplier?)` for fixed / exponential backoff and `.preventOverlap()` for external-invocation safety. Triggers: `.retry`, `.preventOverlap`, `maxRetries`, `backoffMultiplier`, `JobResult.retries`, `job:error`, `job:skip`; "how do I retry a failed job", "exponential backoff for scheduled job", "prevent concurrent job runs", "stop firing after N consecutive failures"; typical import `import { job, scheduler } from "@warlock.js/scheduler"`. Skip: events / shutdown — `@warlock.js/scheduler/observe-scheduler/SKILL.md`; building the schedule itself — `@warlock.js/scheduler/schedule-fluently/SKILL.md`; competing libs `p-retry`, `async-retry`, `bullmq`.'
----
-
-# Retry, backoff, and overlap
-
-Two independent execution-control concerns on a single `Job`. They compose cleanly.
-
-## `.retry(maxRetries, delay?, backoffMultiplier?)`
-
-```ts
-job("send-report", sendReport)
-  .daily()
-  .at("08:00")
-  .retry(3);                  // 3 retries, 1000ms apart (default delay)
-
-job("sync", syncInventory)
-  .everyHour()
-  .retry(5, 2000);             // 5 retries, 2000ms each
-
-job("queue", processQueue)
-  .everyMinutes(10)
-  .retry(5, 1000, 2);          // exponential: 1s → 2s → 4s → 8s → 16s
-```
-
-**Signature:** `retry(maxRetries: number, delay = 1000, backoffMultiplier?: number): this`
-
-**Formula:** delay before attempt `N+1` = `delay × backoffMultiplier^(N-1)`. Without a multiplier, all retries wait `delay` ms.
-
-**Validation.** Throws at definition time on negative `maxRetries`, negative `delay`, or zero/negative `backoffMultiplier`. `retry(0)` is valid — means "no retries, single attempt."
-
-## Retry count surfaces in `JobResult`
-
-```ts
-scheduler.on("job:complete", (name, result) => {
-  if (result.retries && result.retries > 0) {
-    log.warn({ name, retries: result.retries }, "succeeded after retries");
-  }
-});
-
-scheduler.on("job:error", (name, error) => {
-  // Fires once, AFTER all retries are exhausted.
-  log.error({ name, error }, "failed permanently");
-});
-```
-
-`JobResult.retries`:
-- On **success**: the number of failed attempts before the eventual success (0 if first attempt succeeded).
-- On **failure**: equals the configured `maxRetries` (all of them were used).
-
-## After permanent failure — `nextRun` advances normally
-
-This is load-bearing: a job that exhausts every retry and still throws does **not** re-fire on the next tick. The scheduler:
-
-1. Emits `job:error` once with the final error.
-2. Advances `nextRun` by the job's interval, same as success.
-
-Both branches go through the same `finally`-block path in `Job.run()`. There is no "stuck on retry" mode.
-
-```ts
-// Fires every 10 minutes, retries 3 times per fire.
-// If the 10:00 run exhausts all retries, next run is at 10:10. NOT at 10:00:00.001.
-job("flaky", fn).everyMinutes(10).retry(3, 1000);
-```
-
-To **stop** firing after N consecutive failures, do it in user code:
-
-```ts
-let consecutiveFailures = 0;
-scheduler.on("job:error", name => {
-  if (name !== "flaky") return;
-  consecutiveFailures++;
-  if (consecutiveFailures >= 5) {
-    scheduler.removeJob("flaky");
-    alert.critical("flaky disabled after 5 failures");
-  }
-});
-scheduler.on("job:complete", name => {
-  if (name === "flaky") consecutiveFailures = 0;
-});
-```
-
-## `.preventOverlap(skip = true)`
-
-Tells the scheduler to skip a tick if the job is already running.
-
-```ts
-job("queue", processQueue)
-  .everyMinutes(5)
-  .preventOverlap();
-```
-
-**Important nuance.** The scheduler awaits each tick's jobs before scheduling the next tick — so **concurrent same-job runs from the scheduler's own loop are structurally impossible**, regardless of `preventOverlap()`. Where it actually matters: jobs whose callbacks ALSO get invoked outside the scheduler.
-
-Real-world shapes that benefit:
-
-```ts
-// 1) Boot-time recovery sweep before normal scheduling.
-const queueJob = job("queue", processQueueOnce).everyMinutes(5).preventOverlap();
-scheduler.addJob(queueJob);
-queueJob.run().catch(err => log.error({ err }, "boot sweep failed"));
-scheduler.start();
-
-// 2) Admin-triggered manual re-run from a dashboard endpoint.
-app.post("/admin/jobs/:name/run", async (req, res) => {
-  const j = scheduler.getJob(req.params.name);
-  await j?.run();
-  res.sendStatus(204);
-});
-
-// 3) Multiple scheduler instances pointed at the same Job (rare).
-```
-
-If a tick lands while one of these external runs is mid-flight:
-- Scheduler emits `job:skip` with reason `"Job is already running"`
-- The tick proceeds without re-entering the job
-
-For a single-process app where the callback is only ever invoked via the scheduler, `preventOverlap()` is a no-op — but it's free, defensive documentation. Keep it on for any job that touches shared state.
-
-## Combining retry + preventOverlap
-
-They compose cleanly. Retry happens WITHIN one fire — if all retries fail, the tick ends and `nextRun` advances. `preventOverlap` matters only between fires.
-
-```ts
-job("long-flaky", processQueue)
-  .everyMinutes(5)
-  .preventOverlap()
-  .retry(3, 1000, 2);   // up to 1 + 2 + 4 = 7 s of retry delay per fire
-```
-
-If retries push the total work past the next interval, `preventOverlap()` ensures the next scheduled tick skips instead of stacking.
-
-## See also
-
-- [`@warlock.js/scheduler/observe-scheduler/SKILL.md`](@warlock.js/scheduler/observe-scheduler/SKILL.md) — full event reference, `JobResult` shape, lifecycle
-- [`@warlock.js/scheduler/schedule-fluently/SKILL.md`](@warlock.js/scheduler/schedule-fluently/SKILL.md) — the scheduling methods these compose with
-
-## Running on one server only: `onOneServer()`
-
-`preventOverlap()` is in-process. With several app instances, add `onOneServer()` so only one instance runs each tick:
-
-```ts
-job("nightly-report", buildReport).daily().at("02:00").onOneServer().preventOverlap();
-job("sync", sync).everyMinutes(5).onOneServer({ lockTtl: "10m", key: "sync-v2" });
-```
-
-- Claim key: `scheduler.<key ?? name>.<scheduledTickEpochMs>` (scheduled tick time truncated to the second, so every server derives the same key). Losers skip the tick and the scheduler emits `job:skip`.
-- It is a **claim, not a lock**: a create-only, TTL-bounded cache entry that is never released, only expires. That guarantees one run per tick even if another server's timer fires late, after the winner finished.
-- Default claim TTL: `min(interval, 1h)` with a 60s floor (1h for cron jobs). Override with `lockTtl`.
-- Needs the optional `@warlock.js/cache` peer and a shared driver (redis/pg). On the memory driver it only dedupes within one process.
-- Throws at call time if the job has no name/key.
+---
+name: configure-retry-and-overlap
+description: 'Configure `.retry(maxRetries, delay?, backoffMultiplier?)` for fixed / exponential backoff and `.preventOverlap()` for external-invocation safety. Triggers: `.retry`, `.preventOverlap`, `maxRetries`, `backoffMultiplier`, `JobResult.retries`, `job:error`, `job:skip`; "how do I retry a failed job", "exponential backoff for scheduled job", "prevent concurrent job runs", "stop firing after N consecutive failures"; typical import `import { job, scheduler } from "@warlock.js/scheduler"`. Skip: events / shutdown — `@warlock.js/scheduler/observe-scheduler/SKILL.md`; building the schedule itself — `@warlock.js/scheduler/schedule-fluently/SKILL.md`; competing libs `p-retry`, `async-retry`, `bullmq`.'
+---
+
+# Retry, backoff, and overlap
+
+Two independent execution-control concerns on a single `Job`. They compose cleanly.
+
+## `.retry(maxRetries, delay?, backoffMultiplier?)`
+
+```ts
+job("send-report", sendReport)
+  .daily()
+  .at("08:00")
+  .retry(3);                  // 3 retries, 1000ms apart (default delay)
+
+job("sync", syncInventory)
+  .everyHour()
+  .retry(5, 2000);             // 5 retries, 2000ms each
+
+job("queue", processQueue)
+  .everyMinutes(10)
+  .retry(5, 1000, 2);          // exponential: 1s → 2s → 4s → 8s → 16s
+```
+
+**Signature:** `retry(maxRetries: number, delay = 1000, backoffMultiplier?: number): this`
+
+**Formula:** delay before attempt `N+1` = `delay × backoffMultiplier^(N-1)`. Without a multiplier, all retries wait `delay` ms.
+
+**Validation.** Throws at definition time on negative `maxRetries`, negative `delay`, or zero/negative `backoffMultiplier`. `retry(0)` is valid — means "no retries, single attempt."
+
+## Retry count surfaces in `JobResult`
+
+```ts
+scheduler.on("job:complete", (name, result) => {
+  if (result.retries && result.retries > 0) {
+    log.warn({ name, retries: result.retries }, "succeeded after retries");
+  }
+});
+
+scheduler.on("job:error", (name, error) => {
+  // Fires once, AFTER all retries are exhausted.
+  log.error({ name, error }, "failed permanently");
+});
+```
+
+`JobResult.retries`:
+- On **success**: the number of failed attempts before the eventual success (0 if first attempt succeeded).
+- On **failure**: equals the configured `maxRetries` (all of them were used).
+
+## After permanent failure — `nextRun` advances normally
+
+This is load-bearing: a job that exhausts every retry and still throws does **not** re-fire on the next tick. The scheduler:
+
+1. Emits `job:error` once with the final error.
+2. Advances `nextRun` by the job's interval, same as success.
+
+Both branches go through the same `finally`-block path in `Job.run()`. There is no "stuck on retry" mode.
+
+```ts
+// Fires every 10 minutes, retries 3 times per fire.
+// If the 10:00 run exhausts all retries, next run is at 10:10. NOT at 10:00:00.001.
+job("flaky", fn).everyMinutes(10).retry(3, 1000);
+```
+
+To **stop** firing after N consecutive failures, do it in user code:
+
+```ts
+let consecutiveFailures = 0;
+scheduler.on("job:error", name => {
+  if (name !== "flaky") return;
+  consecutiveFailures++;
+  if (consecutiveFailures >= 5) {
+    scheduler.removeJob("flaky");
+    alert.critical("flaky disabled after 5 failures");
+  }
+});
+scheduler.on("job:complete", name => {
+  if (name === "flaky") consecutiveFailures = 0;
+});
+```
+
+## `.preventOverlap(skip = true)`
+
+Tells the scheduler to skip a tick if the job is already running.
+
+```ts
+job("queue", processQueue)
+  .everyMinutes(5)
+  .preventOverlap();
+```
+
+**Important nuance.** The scheduler awaits each tick's jobs before scheduling the next tick — so **concurrent same-job runs from the scheduler's own loop are structurally impossible**, regardless of `preventOverlap()`. Where it actually matters: jobs whose callbacks ALSO get invoked outside the scheduler.
+
+Real-world shapes that benefit:
+
+```ts
+// 1) Boot-time recovery sweep before normal scheduling.
+const queueJob = job("queue", processQueueOnce).everyMinutes(5).preventOverlap();
+scheduler.addJob(queueJob);
+queueJob.run().catch(err => log.error({ err }, "boot sweep failed"));
+scheduler.start();
+
+// 2) Admin-triggered manual re-run from a dashboard endpoint.
+app.post("/admin/jobs/:name/run", async (req, res) => {
+  const j = scheduler.getJob(req.params.name);
+  await j?.run();
+  res.sendStatus(204);
+});
+
+// 3) Multiple scheduler instances pointed at the same Job (rare).
+```
+
+If a tick lands while one of these external runs is mid-flight:
+- Scheduler emits `job:skip` with reason `"Job is already running"`
+- The tick proceeds without re-entering the job
+
+For a single-process app where the callback is only ever invoked via the scheduler, `preventOverlap()` is a no-op — but it's free, defensive documentation. Keep it on for any job that touches shared state.
+
+## Combining retry + preventOverlap
+
+They compose cleanly. Retry happens WITHIN one fire — if all retries fail, the tick ends and `nextRun` advances. `preventOverlap` matters only between fires.
+
+```ts
+job("long-flaky", processQueue)
+  .everyMinutes(5)
+  .preventOverlap()
+  .retry(3, 1000, 2);   // up to 1 + 2 + 4 = 7 s of retry delay per fire
+```
+
+If retries push the total work past the next interval, `preventOverlap()` ensures the next scheduled tick skips instead of stacking.
+
+## See also
+
+- [`@warlock.js/scheduler/observe-scheduler/SKILL.md`](@warlock.js/scheduler/observe-scheduler/SKILL.md) — full event reference, `JobResult` shape, lifecycle
+- [`@warlock.js/scheduler/schedule-fluently/SKILL.md`](@warlock.js/scheduler/schedule-fluently/SKILL.md) — the scheduling methods these compose with
+
+## Running on one server only: `onOneServer()`
+
+`preventOverlap()` is in-process. With several app instances, add `onOneServer()` so only one instance runs each tick:
+
+```ts
+job("nightly-report", buildReport).daily().at("02:00").onOneServer().preventOverlap();
+job("sync", sync).everyMinutes(5).onOneServer({ lockTtl: "10m", key: "sync-v2" });
+```
+
+- Claim key: `scheduler.<key ?? name>.<scheduledTickEpochMs>` (scheduled tick time truncated to the second, so every server derives the same key). Losers skip the tick and the scheduler emits `job:skip`.
+- It is a **claim, not a lock**: a create-only, TTL-bounded cache entry that is never released, only expires. That guarantees one run per tick even if another server's timer fires late, after the winner finished.
+- Default claim TTL: `min(interval, 1h)` with a 60s floor (1h for cron jobs). Override with `lockTtl`.
+- Needs the optional `@warlock.js/cache` peer and a shared driver (redis/pg). On the memory driver it only dedupes within one process.
+- Throws at call time if the job has no name/key.

package/skills/observe-scheduler/SKILL.md

@@ -1,153 +1,153 @@
----
-name: observe-scheduler
-description: 'Subscribe to scheduler lifecycle and job events for logging / metrics / alerting / graceful shutdown — seven typed `SchedulerEvents`, `JobResult` payload, `start()` / `stop()` / `shutdown()`. Triggers: `scheduler.on`, `scheduler.shutdown`, `JobResult`, `job:complete`, `job:error`, `scheduler:started`, `scheduler.getJob`; "graceful SIGTERM shutdown", "did this job run", "scheduler metrics and alerts", "subscribe to job events"; typical import `import { scheduler, type JobResult } from "@warlock.js/scheduler"`. Skip: retry / overlap — `@warlock.js/scheduler/configure-retry-and-overlap/SKILL.md`; building schedules — `@warlock.js/scheduler/schedule-fluently/SKILL.md`; native `EventEmitter`, `process.on`.'
----
-
-# Observability and lifecycle
-
-The `Scheduler` extends Node's `EventEmitter` with a fully-typed surface. Wire listeners before calling `.start()`.
-
-## All seven events
-
-```ts
-type SchedulerEvents = {
-  "job:start":         [jobName: string];
-  "job:complete":      [jobName: string, result: JobResult];
-  "job:error":         [jobName: string, error: unknown];
-  "job:skip":          [jobName: string, reason: string];
-  "scheduler:started": [];
-  "scheduler:stopped": [];
-  "scheduler:tick":    [timestamp: Date];
-};
-```
-
-| Event                | When it fires                                                                          |
-| -------------------- | -------------------------------------------------------------------------------------- |
-| `scheduler:started`  | Once, after `.start()` enters the tick loop                                            |
-| `scheduler:stopped`  | When `.stop()` halts the loop. Not emitted if `.stop()` was a no-op (never started)    |
-| `scheduler:tick`     | Every tick — once per `runEvery()` interval (default 1 s). Keep handlers lightweight.  |
-| `job:start`          | Just before a job's callback is first invoked (NOT once per retry)                     |
-| `job:complete`       | When a job finishes successfully (possibly after retries)                              |
-| `job:error`          | When a job exhausts all retries and the final attempt still throws                     |
-| `job:skip`           | When a tick finds the job already running (see retry-and-overlap for when this occurs) |
-
-**Contract for retries.** `job:start` and `job:complete`/`job:error` fire **once per fire**, not once per retry attempt. The retry count surfaces inside the `JobResult` passed to `job:complete`, or as `result.retries === maxRetries` on the failure path.
-
-## `JobResult` shape
-
-```ts
-type JobResult = {
-  success: boolean;
-  duration: number;    // milliseconds, end-to-end including retry waits
-  error?: unknown;     // present when success === false
-  retries?: number;    // attempts that failed before the final outcome
-};
-```
-
-`duration` is wall-clock from the first attempt's start to the final settlement — useful for both p50 metrics and capacity planning.
-
-## Subscribing
-
-```ts
-import type { JobResult } from "@warlock.js/scheduler";
-import { scheduler } from "@warlock.js/scheduler";
-
-scheduler.on("job:start",    name           => log.debug({ name }, "job start"));
-scheduler.on("job:complete", (name, result: JobResult) => {
-  log.info({ name, duration: result.duration, retries: result.retries }, "job complete");
-});
-scheduler.on("job:error",    (name, error)  => log.error({ name, error }, "job failed"));
-scheduler.on("job:skip",     (name, reason) => log.warn({ name, reason }, "job skipped"));
-```
-
-`.on()`, `.once()`, `.off()` are all type-narrowed via `SchedulerEvents`.
-
-## Lifecycle methods
-
-### `.start()`
-
-Prepares every registered job (computes initial `nextRun`) and enters the tick loop. Emits `scheduler:started`.
-
-Throws if:
-- already running (`"Scheduler is already running."`)
-- zero jobs registered (`"Cannot start scheduler with no jobs."`)
-
-### `.stop()`
-
-Immediately clears the next-tick timer. Does NOT wait for jobs currently mid-execution. Emits `scheduler:stopped`. **No-op if not running** — calling `.stop()` on a never-started or already-stopped scheduler is safe and silent.
-
-### `.shutdown(timeout = 30000)`
-
-Graceful equivalent of `.stop()`:
-
-1. Marks the scheduler as shutting down (no new ticks scheduled).
-2. Calls `.stop()` internally (so `scheduler:stopped` fires).
-3. Awaits every currently-running job's `waitForCompletion()`, capped by `timeout`.
-4. Resolves either when all jobs finish or when the timeout elapses.
-
-```ts
-process.on("SIGTERM", async () => {
-  await scheduler.shutdown(30_000);
-  process.exit(0);
-});
-```
-
-The timeout is a HARD cap — jobs still running after it are abandoned (their promises keep resolving in the background, but the scheduler doesn't await them). The package does not currently support per-job timeouts or `AbortSignal` cancellation.
-
-## Production observer pattern
-
-Wire all observers before `start()`, in one place:
-
-```ts
-import { scheduler } from "@warlock.js/scheduler";
-import { logger } from "./logger";
-import { metrics } from "./metrics";
-import { alerts } from "./alerts";
-
-scheduler.on("job:start", name => metrics.increment(`job.start.${name}`));
-
-scheduler.on("job:complete", (name, result) => {
-  metrics.increment(`job.success.${name}`);
-  metrics.timing(`job.duration.${name}`, result.duration);
-  if (result.retries) metrics.increment(`job.retries.${name}`, result.retries);
-});
-
-scheduler.on("job:error", (name, error) => {
-  logger.error({ name, error }, "Job failed permanently");
-  alerts.critical(`Scheduler job "${name}" failed`, error);
-});
-
-scheduler.on("job:skip", (name, reason) => {
-  logger.warn({ name, reason }, "Job skipped — likely external invocation in flight");
-});
-
-scheduler.on("scheduler:started", () => logger.info("scheduler up"));
-scheduler.on("scheduler:stopped", () => logger.info("scheduler down"));
-
-// Register jobs, then:
-scheduler.start();
-```
-
-## Inspection at runtime
-
-```ts
-scheduler.isRunning;             // boolean
-scheduler.jobCount;              // number of registered jobs
-scheduler.list();                // readonly Job[]
-scheduler.getJob("name");        // Job | undefined
-```
-
-And on each `Job`:
-
-```ts
-job.nextRun;                     // Dayjs | null
-job.lastRun;                     // Dayjs | null — success OR failure
-job.isRunning;                   // boolean
-job.intervals;                   // readonly schedule config
-job.cronExpression;              // string | null
-```
-
-## See also
-
-- [`@warlock.js/scheduler/configure-retry-and-overlap/SKILL.md`](@warlock.js/scheduler/configure-retry-and-overlap/SKILL.md) — what triggers each event in detail
-- [`@warlock.js/scheduler/schedule-fluently/SKILL.md`](@warlock.js/scheduler/schedule-fluently/SKILL.md) — the methods that mutate the state these getters expose
+---
+name: observe-scheduler
+description: 'Subscribe to scheduler lifecycle and job events for logging / metrics / alerting / graceful shutdown — seven typed `SchedulerEvents`, `JobResult` payload, `start()` / `stop()` / `shutdown()`. Triggers: `scheduler.on`, `scheduler.shutdown`, `JobResult`, `job:complete`, `job:error`, `scheduler:started`, `scheduler.getJob`; "graceful SIGTERM shutdown", "did this job run", "scheduler metrics and alerts", "subscribe to job events"; typical import `import { scheduler, type JobResult } from "@warlock.js/scheduler"`. Skip: retry / overlap — `@warlock.js/scheduler/configure-retry-and-overlap/SKILL.md`; building schedules — `@warlock.js/scheduler/schedule-fluently/SKILL.md`; native `EventEmitter`, `process.on`.'
+---
+
+# Observability and lifecycle
+
+The `Scheduler` extends Node's `EventEmitter` with a fully-typed surface. Wire listeners before calling `.start()`.
+
+## All seven events
+
+```ts
+type SchedulerEvents = {
+  "job:start":         [jobName: string];
+  "job:complete":      [jobName: string, result: JobResult];
+  "job:error":         [jobName: string, error: unknown];
+  "job:skip":          [jobName: string, reason: string];
+  "scheduler:started": [];
+  "scheduler:stopped": [];
+  "scheduler:tick":    [timestamp: Date];
+};
+```
+
+| Event                | When it fires                                                                          |
+| -------------------- | -------------------------------------------------------------------------------------- |
+| `scheduler:started`  | Once, after `.start()` enters the tick loop                                            |
+| `scheduler:stopped`  | When `.stop()` halts the loop. Not emitted if `.stop()` was a no-op (never started)    |
+| `scheduler:tick`     | Every tick — once per `runEvery()` interval (default 1 s). Keep handlers lightweight.  |
+| `job:start`          | Just before a job's callback is first invoked (NOT once per retry)                     |
+| `job:complete`       | When a job finishes successfully (possibly after retries)                              |
+| `job:error`          | When a job exhausts all retries and the final attempt still throws                     |
+| `job:skip`           | When a tick finds the job already running (see retry-and-overlap for when this occurs) |
+
+**Contract for retries.** `job:start` and `job:complete`/`job:error` fire **once per fire**, not once per retry attempt. The retry count surfaces inside the `JobResult` passed to `job:complete`, or as `result.retries === maxRetries` on the failure path.
+
+## `JobResult` shape
+
+```ts
+type JobResult = {
+  success: boolean;
+  duration: number;    // milliseconds, end-to-end including retry waits
+  error?: unknown;     // present when success === false
+  retries?: number;    // attempts that failed before the final outcome
+};
+```
+
+`duration` is wall-clock from the first attempt's start to the final settlement — useful for both p50 metrics and capacity planning.
+
+## Subscribing
+
+```ts
+import type { JobResult } from "@warlock.js/scheduler";
+import { scheduler } from "@warlock.js/scheduler";
+
+scheduler.on("job:start",    name           => log.debug({ name }, "job start"));
+scheduler.on("job:complete", (name, result: JobResult) => {
+  log.info({ name, duration: result.duration, retries: result.retries }, "job complete");
+});
+scheduler.on("job:error",    (name, error)  => log.error({ name, error }, "job failed"));
+scheduler.on("job:skip",     (name, reason) => log.warn({ name, reason }, "job skipped"));
+```
+
+`.on()`, `.once()`, `.off()` are all type-narrowed via `SchedulerEvents`.
+
+## Lifecycle methods
+
+### `.start()`
+
+Prepares every registered job (computes initial `nextRun`) and enters the tick loop. Emits `scheduler:started`.
+
+Throws if:
+- already running (`"Scheduler is already running."`)
+- zero jobs registered (`"Cannot start scheduler with no jobs."`)
+
+### `.stop()`
+
+Immediately clears the next-tick timer. Does NOT wait for jobs currently mid-execution. Emits `scheduler:stopped`. **No-op if not running** — calling `.stop()` on a never-started or already-stopped scheduler is safe and silent.
+
+### `.shutdown(timeout = 30000)`
+
+Graceful equivalent of `.stop()`:
+
+1. Marks the scheduler as shutting down (no new ticks scheduled).
+2. Calls `.stop()` internally (so `scheduler:stopped` fires).
+3. Awaits every currently-running job's `waitForCompletion()`, capped by `timeout`.
+4. Resolves either when all jobs finish or when the timeout elapses.
+
+```ts
+process.on("SIGTERM", async () => {
+  await scheduler.shutdown(30_000);
+  process.exit(0);
+});
+```
+
+The timeout is a HARD cap — jobs still running after it are abandoned (their promises keep resolving in the background, but the scheduler doesn't await them). The package does not currently support per-job timeouts or `AbortSignal` cancellation.
+
+## Production observer pattern
+
+Wire all observers before `start()`, in one place:
+
+```ts
+import { scheduler } from "@warlock.js/scheduler";
+import { logger } from "./logger";
+import { metrics } from "./metrics";
+import { alerts } from "./alerts";
+
+scheduler.on("job:start", name => metrics.increment(`job.start.${name}`));
+
+scheduler.on("job:complete", (name, result) => {
+  metrics.increment(`job.success.${name}`);
+  metrics.timing(`job.duration.${name}`, result.duration);
+  if (result.retries) metrics.increment(`job.retries.${name}`, result.retries);
+});
+
+scheduler.on("job:error", (name, error) => {
+  logger.error({ name, error }, "Job failed permanently");
+  alerts.critical(`Scheduler job "${name}" failed`, error);
+});
+
+scheduler.on("job:skip", (name, reason) => {
+  logger.warn({ name, reason }, "Job skipped — likely external invocation in flight");
+});
+
+scheduler.on("scheduler:started", () => logger.info("scheduler up"));
+scheduler.on("scheduler:stopped", () => logger.info("scheduler down"));
+
+// Register jobs, then:
+scheduler.start();
+```
+
+## Inspection at runtime
+
+```ts
+scheduler.isRunning;             // boolean
+scheduler.jobCount;              // number of registered jobs
+scheduler.list();                // readonly Job[]
+scheduler.getJob("name");        // Job | undefined
+```
+
+And on each `Job`:
+
+```ts
+job.nextRun;                     // Dayjs | null
+job.lastRun;                     // Dayjs | null — success OR failure
+job.isRunning;                   // boolean
+job.intervals;                   // readonly schedule config
+job.cronExpression;              // string | null
+```
+
+## See also
+
+- [`@warlock.js/scheduler/configure-retry-and-overlap/SKILL.md`](@warlock.js/scheduler/configure-retry-and-overlap/SKILL.md) — what triggers each event in detail
+- [`@warlock.js/scheduler/schedule-fluently/SKILL.md`](@warlock.js/scheduler/schedule-fluently/SKILL.md) — the methods that mutate the state these getters expose