Skip to main content

Function: getListItemIterator()

getListItemIterator<HostPartT, ItemT>(host, itemLocatorBase, driverClass, startIndex): AsyncGenerator<ItemT, void, unknown>

Defined in: packages/core/src/drivers/listHelper.ts:39

Get an iterator of list item driver. List item is an indefinite number of items under the same host

Type Parameters​

HostPartT​

HostPartT extends ScenePart

ItemT​

ItemT extends ComponentDriver<{ }>

Parameters​

host​

ComponentDriver<HostPartT>

The component the list item is under

itemLocatorBase​

PartLocator

The locator of the list item without the index, the locator should already compound the host locator if needed

driverClass​

ComponentDriverCtor<ItemT>

The driver class of the list item

startIndex​

number = 0

The starting index of the list item iterator, default is 0

Returns​

AsyncGenerator<ItemT, void, unknown>