rc-js-util/docs/rc-js-util._iterator.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; [\_Iterator](./rc-js-util._iterator.md)

## \_Iterator class

Utilities relating to `IterableIterator` &amp; generators.

**Signature:**

```typescript
export declare class _Iterator 
```

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[consumeAll](./rc-js-util._iterator.consumeall.md)


</td><td>

`static`

`readonly`


</td><td>

typeof iteratorConsumeAll


</td><td>

Iterate over an iterator until it's done, discarding the results.


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

[emptyIterator](./rc-js-util._iterator.emptyiterator.md)


</td><td>

`static`


</td><td>

IterableIterator&lt;any&gt; &amp; { result: { done: true; value: any; }; }


</td><td>

An iterator that is done.


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