Graphorin API reference v0.15.1

---

Graphorin API reference / @graphorin/proactive / / ProactiveCronTask

Interface: ProactiveCronTask

Defined in: packages/proactive/src/cron-task.ts:212

Stable

The cron-leg task handle.

Properties

Property	Modifier	Type	Defined in
id	readonly	string	packages/proactive/src/cron-task.ts:213

Methods

fire()

fire(): Promise<ProactiveTaskFireResult>;

Defined in: packages/proactive/src/cron-task.ts:219

Fire once now (also the trigger callback).

Returns

Promise<ProactiveTaskFireResult>

---

start()

start(): Promise<void>;

Defined in: packages/proactive/src/cron-task.ts:215

Register the schedule on the scheduler. Idempotent.

Returns

Promise<void>

---

status()

status(): ProactiveCronTaskStatus;

Defined in: packages/proactive/src/cron-task.ts:220

Returns

ProactiveCronTaskStatus

---

stop()

stop(): Promise<void>;

Defined in: packages/proactive/src/cron-task.ts:217

Unregister the schedule.

Returns

Promise<void>