@epikodelabs/streamix / src/public-api / timer
Function: timer()
timer(
delayMs?,intervalMs?):Stream<number>
Defined in: projects/libraries/streamix/src/lib/streams/timer.ts:15
Creates a timer stream that emits numbers starting from 0.
This stream is useful for scheduling events or generating periodic data. It is analogous to setInterval but as an asynchronous stream.
Parameters
delayMs?
MaybePromise<number> = 0
The time in milliseconds to wait before emitting the first value (0). If 0, the first value is emitted immediately (in the next microtask).
intervalMs?
MaybePromise<number>
The time in milliseconds between subsequent emissions. If not provided, it defaults to delayMs.
Returns
Stream<number>
A stream that emits incrementing numbers (0, 1, 2, ...).