Graphorin API reference v0.8.0

---

Graphorin API reference / @graphorin/proactive / / ProactiveCronTask

Interface: ProactiveCronTask

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

The cron-leg task handle.

Stable

Properties

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

Methods

fire()

fire(): Promise<ProactiveTaskFireResult>;

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

Fire once now (also the trigger callback).

Returns

Promise<ProactiveTaskFireResult>

---

start()

start(): Promise<void>;

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

Register the schedule on the scheduler. Idempotent.

Returns

Promise<void>

---

status()

status(): ProactiveCronTaskStatus;

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

Returns

ProactiveCronTaskStatus

---

stop()

stop(): Promise<void>;

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

Unregister the schedule.

Returns

Promise<void>