Skip to main content

Function: getListItemByIndex()

getListItemByIndex<HostPartT, ItemT>(host, itemLocatorBase, index, driverClass): Promise<ItemT | null>

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

Get list item driver within host by index. List item is an indefinite number of items under the same host with similar characteristics defined by the itemLocatorBase.

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

index​

number

The index of the list item

driverClass​

ComponentDriverCtor<ItemT>

The driver class of the list item

Returns​

Promise<ItemT | null>