Skip to main content

Class: EntityIterator

This type is usable for iterating over a set of entities. This means it can be used in statements like for...of statements, Array.from(iterator), and more.

Implements

Constructors

new EntityIterator()

private new EntityIterator(): EntityIterator

Returns

EntityIterator

Methods

[iterator]()

[iterator](): Iterator ↗️ <Entity, any, undefined>

Returns

Iterator ↗️ <Entity, any, undefined>

Implementation of

Iterable.[iterator]

Remarks

This function can't be called in read-only mode.


next()

next(): IteratorResult ↗️ <Entity, any>

Returns

IteratorResult ↗️ <Entity, any>

Remarks

Retrieves the next item in this iteration. The resulting IteratorResult contains .done and .value properties which can be used to see the next Entity in the iteration.

This function can't be called in read-only mode.