Graphorin API reference v0.1.0
Graphorin API reference / @graphorin/triggers / / Scheduler
Interface: Scheduler
Defined in: packages/triggers/src/index.ts:195
Public Scheduler surface.
Stable
Methods
emit()
emit(eventName, payload?): Promise<void>;Defined in: packages/triggers/src/index.ts:202
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:206
AsyncIterable lifecycle event stream.
Returns
AsyncIterable<SchedulerEvent>
fire()
fire(id, payload?): Promise<void>;Defined in: packages/triggers/src/index.ts:204
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:198
Returns
Promise<readonly TriggerState[]>
recordActivity()
recordActivity(): void;Defined in: packages/triggers/src/index.ts:208
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:196
Parameters
| Parameter | Type |
|---|---|
declaration | TriggerDeclaration |
Returns
Promise<TriggerState>
start()
start(): Promise<void>;Defined in: packages/triggers/src/index.ts:199
Returns
Promise<void>
stop()
stop(): Promise<void>;Defined in: packages/triggers/src/index.ts:200
Returns
Promise<void>
unregister()
unregister(id): Promise<void>;Defined in: packages/triggers/src/index.ts:197
Parameters
| Parameter | Type |
|---|---|
id | string |
Returns
Promise<void>