rc-js-util/docs/rc-js-util.incrementalupdater.md

A collection of TS and C++ utilities to help writing performant and correct applications, achieved through strict typing and (removable) invariant checking.

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [rc-js-util](./rc-js-util.md) &gt; [IncrementalUpdater](./rc-js-util.incrementalupdater.md)

## IncrementalUpdater class

Performs update operations once every `waitPeriod` until the iterator returned by [IIncrementallyUpdatable](./rc-js-util.iincrementallyupdatable.md) is exhausted.

**Signature:**

```typescript
export declare class IncrementalUpdater implements IIncrementalUpdater 
```
**Implements:** [IIncrementalUpdater](./rc-js-util.iincrementalupdater.md)

## Constructors

<table><thead><tr><th>

Constructor


</th><th>

Modifiers


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[(constructor)(updatable, waitPeriod)](./rc-js-util.incrementalupdater._constructor_.md)


</td><td>


</td><td>

Constructs a new instance of the `IncrementalUpdater` class


</td></tr>
</tbody></table>

## Properties

<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[isUpdating](./rc-js-util.incrementalupdater.isupdating.md)


</td><td>


</td><td>

boolean


</td><td>

Remains true while the update is suspended.


</td></tr>
</tbody></table>

## Methods

<table><thead><tr><th>

Method


</th><th>

Modifiers


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[beginUpdate()](./rc-js-util.incrementalupdater.beginupdate.md)


</td><td>


</td><td>

Start a new update cycle. If an update was already in progress it will be cancelled.


</td></tr>
<tr><td>

[cancel()](./rc-js-util.incrementalupdater.cancel.md)


</td><td>


</td><td>

Cancel the update and clear the task.


</td></tr>
<tr><td>

[resume()](./rc-js-util.incrementalupdater.resume.md)


</td><td>


</td><td>

Resumes the currently suspended task. It is an error to call this if there is not a currently suspended task.


</td></tr>
<tr><td>

[suspend()](./rc-js-util.incrementalupdater.suspend.md)


</td><td>


</td><td>

Suspends the current task if one is active.


</td></tr>
</tbody></table>