@antelopejs/interface-redis-scheduler

Task scheduling on Redis for AntelopeJS. You schedule a task for a given time, and a listener in your application runs it when it is due, with up to three retries on failure.

What it offers

• setHandler registers the function that runs one kind of task.
• addTask schedules a task for a Unix timestamp in milliseconds. removeTask removes the queued entry before it runs.
• enableListener starts task processing. disableListener closes only the notification subscriber, not the pending timer.
• Tasks live in a Redis sorted set, so they survive application restarts and every instance of the application sees the same queue. Each due task goes to one listener.

Implementations

Install

Add the interface to the module that schedules tasks:

pnpm add @antelopejs/interface-redis-scheduler

Then add the implementation to the project:

ajs project modules add @antelopejs/redis

Quick start

import { Logging } from "@antelopejs/interface-core/logging";
import {
  addTask,
  disableListener,
  enableListener,
  setHandler,
} from "@antelopejs/interface-redis-scheduler";

const ONE_HOUR_MS = 60 * 60 * 1000;

setHandler("overdue-notice", async (taskInfo) => {
  const { memberId } = JSON.parse(taskInfo);
  Logging.Info(`Remind member ${memberId}`);
});

export async function start() {
  await enableListener();
  await addTask(
    "overdue-notice",
    Date.now() + ONE_HOUR_MS,
    JSON.stringify({ memberId: "M-1042" }),
  );
}

export async function stop() {
  await disableListener();
}

Register a handler before you schedule tasks for it. addTask rejects for a handler name that this process has not registered.

disableListener() is not a full shutdown or pause. A pending timer and running handlers can continue to process tasks. Read the lifecycle and delivery limits before you use it for shutdown.

Documentation

• Introduction and scheduler reference

Compatibility

The module declares these peer dependencies:

Contributing

Read CONTRIBUTING.md before you open a pull request. The local checks are:

pnpm install
pnpm lint
pnpm test

License

Apache-2.0