Interface StatsClassInterface

Contract implemented by models that expose typed summary metrics keyed by canonical data type.

interface StatsClassInterface {
    addStat(stat: DataInterface<unknown>): void;
    clearStats(): void;
    getDistance(): DataDistance;
    getStat<TValue = DefaultDataValue>(
        statType: string,
    ): void | DataInterface<TValue>;
    getStats<TValue = DefaultDataValue>(): Map<string, DataInterface<TValue>>;
    getStatsAsArray<TValue = DefaultDataValue>(): DataInterface<TValue>[];
    removeStat(statType: string): void;
    setDistance(distance: DataDistance): void;
}

Hierarchy (View Summary)

StatsClassInterface

Index

Methods

addStat clearStats getDistance getStat getStats getStatsAsArray removeStat setDistance

Methods

addStat

addStat(stat: DataInterface<unknown>): void
Parameters
- stat: DataInterface<unknown>
Returns void
- Defined in src/stats/stats.class.interface.ts:22

clearStats

clearStats(): void
Returns void
- Defined in src/stats/stats.class.interface.ts:18

getDistance

getDistance(): DataDistance
Returns DataDistance
- Defined in src/stats/stats.class.interface.ts:8

getStat

getStat<TValue = DefaultDataValue>(
statType: string,
): void | DataInterface<TValue>
Type Parameters
- TValue = DefaultDataValue
Parameters
- statType: string
Returns void | DataInterface<TValue>
- Defined in src/stats/stats.class.interface.ts:10

getStats

getStats<TValue = DefaultDataValue>(): Map<string, DataInterface<TValue>>
Type Parameters
- TValue = DefaultDataValue
Returns Map<string, DataInterface<TValue>>
- Defined in src/stats/stats.class.interface.ts:12

getStatsAsArray

getStatsAsArray<TValue = DefaultDataValue>(): DataInterface<TValue>[]
Type Parameters
- TValue = DefaultDataValue
Returns DataInterface<TValue>[]
- Defined in src/stats/stats.class.interface.ts:14

removeStat

removeStat(statType: string): void
Parameters
- statType: string
Returns void
- Defined in src/stats/stats.class.interface.ts:16

setDistance

setDistance(distance: DataDistance): void
Parameters
- distance: DataDistance
Returns void
- Defined in src/stats/stats.class.interface.ts:20