Class StatsUtilities

Index

Constructors

Methods

aggregateNumericRecords average getFiniteNumericRecordValue getFiniteNumericValue getFiniteStatValue max min serializeStats sum weightedAverage

Constructors

constructor

new StatsUtilities(): StatsUtilities
Returns StatsUtilities

Methods

`Static`aggregateNumericRecords

aggregateNumericRecords(
records: readonly unknown[],
aggregations: readonly NumericRecordAggregation[],
): Record<string, number>
Parameters
- records: readonly unknown[]
- aggregations: readonly NumericRecordAggregation[]
Returns Record<string, number>
- Defined in src/stats/stats.utilities.ts:59

`Static`average

average(
sources: Pick<StatsClassInterface, "getStat">[],
statType: string,
): number | null
Parameters
- sources: Pick<StatsClassInterface, "getStat">[]
- statType: string
Returns number | null
- Defined in src/stats/stats.utilities.ts:118

`Static`getFiniteNumericRecordValue

getFiniteNumericRecordValue(
source: unknown,
keys: readonly string[],
): number | null
Parameters
- source: unknown
- keys: readonly string[]
Returns number | null
- Defined in src/stats/stats.utilities.ts:43

`Static`getFiniteNumericValue

getFiniteNumericValue(value: unknown): number | null
Parameters
- value: unknown
Returns number | null
- Defined in src/stats/stats.utilities.ts:30

`Static`getFiniteStatValue

getFiniteStatValue(
source: Pick<StatsClassInterface, "getStat">,
statType: string,
): number | null
Parameters
- source: Pick<StatsClassInterface, "getStat">
- statType: string
Returns number | null
- Defined in src/stats/stats.utilities.ts:25

`Static`max

max(
sources: Pick<StatsClassInterface, "getStat">[],
statType: string,
): number | null
Parameters
- sources: Pick<StatsClassInterface, "getStat">[]
- statType: string
Returns number | null
- Defined in src/stats/stats.utilities.ts:113

`Static`min

min(
sources: Pick<StatsClassInterface, "getStat">[],
statType: string,
): number | null
Parameters
- sources: Pick<StatsClassInterface, "getStat">[]
- statType: string
Returns number | null
- Defined in src/stats/stats.utilities.ts:108

`Static`serializeStats

serializeStats(
stats: Map<string, DataInterface<DefaultDataValue>>,
): DataJSONInterface
Parameters
- stats: Map<string, DataInterface<DefaultDataValue>>
Returns DataJSONInterface
- Defined in src/stats/stats.utilities.ts:17

`Static`sum

sum(
sources: Pick<StatsClassInterface, "getStat">[],
statType: string,
): number | null
Parameters
- sources: Pick<StatsClassInterface, "getStat">[]
- statType: string
Returns number | null
- Defined in src/stats/stats.utilities.ts:92

`Static`weightedAverage

weightedAverage(
    sources: Pick<StatsClassInterface, "getStat">[],
    valueStatType: string,
    weightStatType: string,
): number | null
Parameters
- sources: Pick<StatsClassInterface, "getStat">[]
- valueStatType: string
- weightStatType: string
Returns number | null
- Defined in src/stats/stats.utilities.ts:123