Class StatisticLinkDiscovery

Base class for statistics with event emitter logic implemented. Statistic tracker implementations should only define their updateStatistic function.

Hierarchy (View Summary)

StatisticBase<IDiscoverEventData>
- StatisticLinkDiscovery

Index

Constructors

Properties

count key metadata

Methods

emit getListeners on removeListener updateStatistic

Constructors

constructor

new StatisticLinkDiscovery(): StatisticLinkDiscovery
Returns StatisticLinkDiscovery
Overrides StatisticBase.constructor
- Defined in statistic-link-discovery/lib/StatisticLinkDiscovery.ts:18

Properties

count

count: number

key

key: ActionContextKey<IStatisticBase<IDiscoverEventData>>

metadata

metadata: Record<string, Record<any, any>[]>

Methods

emit

emit(data: IDiscoverEventData): boolean
Emits a new statistic event to all listeners
Parameters
- data: IDiscoverEventData
  Statistic data to emit
Returns boolean
Inherited from StatisticBase.emit
- Defined in statistic-base/lib/StatisticBase.ts:27

getListeners

getListeners(): ((data: IDiscoverEventData) => any)[]
Returns ((data: IDiscoverEventData) => any)[]
All listeners on statistic
Inherited from StatisticBase.getListeners
- Defined in statistic-base/lib/StatisticBase.ts:37

on

on(
listener: (data: IDiscoverEventData) => any,
): StatisticBase<IDiscoverEventData>
Attaches a listener to the statistic to listen for new statistic events
Parameters
- listener: (data: IDiscoverEventData) => any
Returns StatisticBase<IDiscoverEventData>
Inherited from StatisticBase.on
- Defined in statistic-base/lib/StatisticBase.ts:10

removeListener

removeListener(
listener: (data: IDiscoverEventData) => any,
): StatisticBase<IDiscoverEventData>
Removes a listener from the statistic
Parameters
- listener: (data: IDiscoverEventData) => any
Returns StatisticBase<IDiscoverEventData>
Inherited from StatisticBase.removeListener
- Defined in statistic-base/lib/StatisticBase.ts:15

updateStatistic

updateStatistic(link: ILink, parent: ILink): boolean
Updates the statistic with new information from query processing
Parameters
- link: ILink
  Statistic data to process
- parent: ILink
Returns boolean
Overrides StatisticBase.updateStatistic
- Defined in statistic-link-discovery/lib/StatisticLinkDiscovery.ts:25