Class StatisticIntermediateResults

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

Hierarchy (View Summary)

StatisticBase<PartialResult>
- StatisticIntermediateResults

Index

Constructors

Properties

Methods

emit getListeners on removeListener updateStatistic

Constructors

constructor

new StatisticIntermediateResults(): StatisticIntermediateResults
Returns StatisticIntermediateResults
Inherited from StatisticBase.constructor

Properties

key

key: ActionContextKey<IStatisticBase<PartialResult>> = KeysStatistics.intermediateResults

Methods

emit

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

getListeners

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

on

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

removeListener

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

updateStatistic

updateStatistic(intermediateResult: PartialResult): boolean
Updates the statistic with new information from query processing
Parameters
- intermediateResult: PartialResult
  Statistic data to process
Returns boolean
Overrides StatisticBase.updateStatistic
- Defined in statistic-intermediate-results/lib/StatisticIntermediateResults.ts:10