Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IValuePageElementMapOpts<Store, K, PageElementType, PageElementOpts, ValueType>

Describes the identifier property of the opts parameter passed to ValuePageElementMap's constructor function.

template

Store type of the PageNodeStore instance which can be used to retrieve/create PageNodes

template

K the key names of ValuePageElementMap's $ accessor used to access the map's managed ValuePageElements

template

PageElementType type of the ValuePageElement managed by ValuePageElementMap

template

PageElementOpts type of the opts parameter passed to the constructor function of the ValuePageElements managed by ValuePageElementMap

template

ValueType type of the values of ValuePageElements managed by ValuePageElementMap

Type parameters

Hierarchy

Index

Properties

elementOpts

elementOpts: PageElementOpts

the options passed to elementStoreFunc to configure the retrieved PageElement instance

elementStoreFunc

elementStoreFunc: function

This function retrieves an instance of a PageElement mapped by PageElementMap from the map's PageNodeStore.

param

the XPath expression used to identify the retrieved PageElement in the DOM

param

the options used to configure the retrieved PageElement

Type declaration

    • (selector: string, options: PageElementOpts): PageElementType
    • Parameters

      • selector: string
      • options: PageElementOpts

      Returns PageElementType

identifier

This identifier provides a mappingObject and a mappingFunc which are used to constrain the "base" XPath selector of PageElementMap using XPath modification functions in order to statically identify a PageElementMap's managed PageElements when the PageElementMap is initially created.

Optional interval

interval: number

An interval in milliseconds.

store

store: Store

an instance of PageNodeStore which can be used to retrieve/create PageNodes

Optional timeout

timeout: number

A timeout in milliseconds.

Generated using TypeDoc