Skip to content

Graphorin API reference v0.8.0


Graphorin API reference / @graphorin/proactive / / HeartbeatSchedule

Interface: HeartbeatSchedule

Defined in: packages/proactive/src/heartbeat.ts:38

When the heartbeat fires. Exactly one of every / cron is required. jitterMs / expiresAt pass through to the trigger declaration (the C4 scheduler harness).

Stable

Properties

PropertyModifierTypeDescriptionDefined in
cron?readonlystring5-field cron expression.packages/proactive/src/heartbeat.ts:42
every?readonlynumberFixed interval in milliseconds.packages/proactive/src/heartbeat.ts:40
expiresAt?readonlystring | numberAuto-pause instant (C4).packages/proactive/src/heartbeat.ts:48
jitterMs?readonlynumberDeterministic per-id jitter (C4).packages/proactive/src/heartbeat.ts:46
timezone?readonlystringIANA timezone for the cron expression (W-124).packages/proactive/src/heartbeat.ts:44