TimerScheduler
このコンテンツはまだ日本語訳がありません。
Defined in: src/ActorContext.ts:188
Actor-scoped scheduler. A fresh startSingleTimer/startTimerWithFixedDelay
call with the same key replaces any existing timer under that key.
Type Parameters
Section titled “Type Parameters”TMsg = unknown
Methods
Section titled “Methods”activeKeys()
Section titled “activeKeys()”activeKeys():
string[]
Defined in: src/ActorContext.ts:210
Names of active timers (diagnostics).
Returns
Section titled “Returns”string[]
cancel()
Section titled “cancel()”cancel(
key):boolean
Defined in: src/ActorContext.ts:201
Cancel a specific timer. Returns true if a timer was actually running.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
cancelAll()
Section titled “cancelAll()”cancelAll():
void
Defined in: src/ActorContext.ts:204
Cancel every timer this actor has started.
Returns
Section titled “Returns”void
isTimerActive()
Section titled “isTimerActive()”isTimerActive(
key):boolean
Defined in: src/ActorContext.ts:207
True if the timer under key is still scheduled to fire.
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”boolean
startSingleTimer()
Section titled “startSingleTimer()”startSingleTimer(
key,message,delayMs):void
Defined in: src/ActorContext.ts:190
Fire message once after delayMs.
Parameters
Section titled “Parameters”string
message
Section titled “message”TMsg
delayMs
Section titled “delayMs”number
Returns
Section titled “Returns”void
startTimerWithFixedDelay()
Section titled “startTimerWithFixedDelay()”startTimerWithFixedDelay(
key,message,intervalMs,initialDelayMs?):void
Defined in: src/ActorContext.ts:193
Fire message every intervalMs, optionally preceded by initialDelayMs.
Parameters
Section titled “Parameters”string
message
Section titled “message”TMsg
intervalMs
Section titled “intervalMs”number
initialDelayMs?
Section titled “initialDelayMs?”number
Returns
Section titled “Returns”void