Graphorin API reference v0.15.1
Graphorin API reference / @graphorin/proactive / / Heartbeat
Interface: Heartbeat
Defined in: packages/proactive/src/heartbeat.ts:186
Stable
The heartbeat handle.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
id | readonly | string | The registered trigger id. | packages/proactive/src/heartbeat.ts:195 |
Methods
beat()
ts
beat(): Promise<HeartbeatBeatResult>;Defined in: packages/proactive/src/heartbeat.ts:192
Fire one beat now (also the trigger callback).
Returns
Promise<HeartbeatBeatResult>
start()
ts
start(): Promise<void>;Defined in: packages/proactive/src/heartbeat.ts:188
Register the schedule on the scheduler. Idempotent.
Returns
Promise<void>
status()
ts
status(): HeartbeatStatus;Defined in: packages/proactive/src/heartbeat.ts:193
Returns
stop()
ts
stop(): Promise<void>;Defined in: packages/proactive/src/heartbeat.ts:190
Unregister the schedule and cancel a pending deferral.
Returns
Promise<void>