Home > rc-js-util > IncrementalUpdater
Performs update operations once every waitPeriod until the iterator returned by IIncrementallyUpdatable is exhausted.
Signature:
export declare class IncrementalUpdater implements IIncrementalUpdater
Implements: IIncrementalUpdater
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(updatable, waitPeriod) | Constructs a new instance of the IncrementalUpdater class |
| Property | Modifiers | Type | Description |
|---|---|---|---|
| isUpdating | boolean | Remains true while the update is suspended. |
| Method | Modifiers | Description |
|---|---|---|
| beginUpdate() | Start a new update cycle. If an update was already in progress it will be cancelled. | |
| cancel() | Cancel the update and clear the task. | |
| resume() | Resumes the currently suspended task. It is an error to call this if there is not a currently suspended task. | |
| suspend() | Suspends the current task if one is active. |