> ## Documentation Index
> Fetch the complete documentation index at: https://stars-components.js.org/llms.txt
> Use this file to discover all available pages before exploring further.

# @wolfstar/plugin-scheduled-tasks

> Changelog for @wolfstar/plugin-scheduled-tasks: one-off and repeated tasks for @wolfstar/http-framework, backed by BullMQ.

Changes to [`@wolfstar/plugin-scheduled-tasks`](https://github.com/wolfstar-project/plugins/tree/main/packages/plugin-scheduled-tasks). The plugin runs tasks later or on a schedule, storing their jobs in Redis through [BullMQ](https://docs.bullmq.io/) so they survive restarts and are shared by every process of your bot. For the weekly summary across all packages, see the [changelog overview](https://stars-components.js.org/documentation/changelog/index.md).

## `0.3.0` (2026-10-20)

### New features

* **Own `stars.config` key** — The module sets `meta.configKey`, so you can write its options under the top-level `scheduledTasks` key of `stars.config` instead of the `[specifier, options]` tuple of `modules`. The tuple still works and is merged over the key. The key is typed in `defineConfig` once the module is imported in `stars.config.ts`. ([#259](https://github.com/wolfstar-project/plugins/pull/259))

### Updates

* **New optional peer** — `@wolfstar/schema` (`^0.9.0`) is a new optional peer that carries the `StarsConfig` type the keys extend.

### Migration

* **`@wolfstar/kit` peer raised** — The `@wolfstar/kit` peer range moves from `^0.1.0` to `^0.2.0`, the first version that reads `configKey`. If your project uses `@wolfstar/kit` 0.1, update it.

## `0.2.0` (2026-10-07)

### New features

* **Readiness gate** — Give the plugin a `ready` callback (with optional `readyTimeout` and `readyDelay`) and set `waitForReady: true` on tasks that need your app to be up. A job taken before the app is ready waits. If the timeout passes, the job moves back to `delayed` instead of failing, so it costs no attempt and emits no `scheduledTaskError`. ([#228](https://github.com/wolfstar-project/plugins/pull/228))
* **`scheduledTaskNotReady` event** — `ScheduledTaskEvents.ScheduledTaskNotReady` reports a job that timed out waiting for readiness.
* **`ScheduledTaskHandler#waitForReady()`** — Lets a task wait for readiness by hand.
* **Job and token in `run`** — `ScheduledTaskHandler#run` takes an optional second argument with the BullMQ job and token.

## `0.1.0` (2026-10-04)

### New features

* **New package** — Scheduled tasks for `@wolfstar/http-framework`, the counterpart of `@sapphire/plugin-scheduled-tasks`. Tasks are `ScheduledTask` pieces run by a BullMQ worker. Create them with `container.tasks.create()`, or repeat them on an `interval` or cron `pattern`. List the package in `modules` in `stars.config`, or pass `scheduledTasks()` to `plugins`. See the [package docs](https://stars-components.js.org/documentation/packages/plugin-scheduled-tasks.md). ([#177](https://github.com/wolfstar-project/plugins/pull/177))


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.