basalt / scheduler/src / SchedulerPluginOptions
Interface: SchedulerPluginOptions
Defined in: scheduler/src/index.ts:423
Extends
Properties
autostart?
> optional autostart?: boolean
Defined in: scheduler/src/index.ts:427
Starts the timer at boot. Default: true (turn off in tests).
define?
> optional define?: (schedule) => void
Defined in: scheduler/src/index.ts:425
Callback that defines the schedules — receives the Scheduler at boot.
Parameters
schedule
Returns
void
hooks?
> optional hooks?: HookBus
Defined in: scheduler/src/index.ts:291
Hook bus for scheduler-driven hooks (reconciler:run). schedulerPlugin passes the app's bus.
Inherited from
lock?
> optional lock?: ScheduleLock
Defined in: scheduler/src/index.ts:281
Cross-replica lock for .onOneServer() entries.
Inherited from
lockTtlMs?
> optional lockTtlMs?: number
Defined in: scheduler/src/index.ts:286
TTL for each per-entry, per-tick lock key. Default 60_000 (one tick window — the key embeds the minute, so it only needs to outlive clock skew).