Interface RepeatingTask

interface RepeatingTask {
    setInterval(ms: number): void;
    setTimeout(ms: number): void;
    start(): void;
    stop(): void;
}

Index

Methods

setInterval setTimeout start stop

Methods

setInterval

setInterval(ms: number): void
Update the interval after which the next iteration of the task will run.

This is useful if, for example, you want to retry a task with a short rest duration until it succeeds, then periodically after that.

This only affects the next iteration of the task, if it is currently running, that run will not be interrupted.

Setting the interval to the current value has no effect.
Parameters
- ms: number
Returns void
- Defined in packages/utils/src/repeating-task.ts:17

setTimeout

setTimeout(ms: number): void
Update the amount of time a task will run before the passed abort signal will fire.

This only affects the next iteration of the task, if it is currently running, that run will not be interrupted.
Parameters
- ms: number
Returns void
- Defined in packages/utils/src/repeating-task.ts:26

start

start(): void
Start the task running

Returns void
- Defined in packages/utils/src/repeating-task.ts:31

stop

stop(): void
Stop the task running

Returns void
- Defined in packages/utils/src/repeating-task.ts:36