Graphorin API reference v0.7.0
Graphorin API reference / @graphorin/triggers / / Scheduler
Interface: Scheduler
Defined in: packages/triggers/src/index.ts:204
Public Scheduler surface.
Stable
Methods
emit()
emit(eventName, payload?): Promise<void>;Defined in: packages/triggers/src/index.ts:211
Emit eventName to every registered event trigger.
Parameters
| Parameter | Type |
|---|---|
eventName | string |
payload? | unknown |
Returns
Promise<void>
events()
events(): AsyncIterable<SchedulerEvent>;Defined in: packages/triggers/src/index.ts:222
AsyncIterable lifecycle event stream.
Returns
AsyncIterable<SchedulerEvent>
fire()
fire(id, payload?): Promise<void>;Defined in: packages/triggers/src/index.ts:213
Manually fire id (used by graphorin triggers fire, Phase 15).
Parameters
| Parameter | Type |
|---|---|
id | string |
payload? | unknown |
Returns
Promise<void>
list()
list(): Promise<readonly TriggerState[]>;Defined in: packages/triggers/src/index.ts:207
Returns
Promise<readonly TriggerState[]>
recordActivity()
recordActivity(): void;Defined in: packages/triggers/src/index.ts:224
Notify the scheduler that the user / runtime is no longer idle.
Returns
void
register()
register(declaration): Promise<TriggerState>;Defined in: packages/triggers/src/index.ts:205
Parameters
| Parameter | Type |
|---|---|
declaration | TriggerDeclaration |
Returns
Promise<TriggerState>
setDisabled()
setDisabled(id, disabled): Promise<TriggerState>;Defined in: packages/triggers/src/index.ts:220
Flip the persistent disabled flag (IP-17). Disabling cancels the armed timer but keeps the trigger registered + persisted; enabling recomputes the next fire from now and re-arms. The destructive removal is unregister(...).
Parameters
| Parameter | Type |
|---|---|
id | string |
disabled | boolean |
Returns
Promise<TriggerState>
start()
start(): Promise<void>;Defined in: packages/triggers/src/index.ts:208
Returns
Promise<void>
stop()
stop(): Promise<void>;Defined in: packages/triggers/src/index.ts:209
Returns
Promise<void>
unregister()
unregister(id): Promise<void>;Defined in: packages/triggers/src/index.ts:206
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<void>