Class MetricsManager<T, P>

Type Parameters

T
P extends PropertyOf<T>

Index

Constructors

Methods

boolean date integer number text

Constructors

constructor

new MetricsManager<T, P extends string>(property: P): MetricsManager<T, P>
Type Parameters
- T
- P extends string
Parameters
- property: P
Returns MetricsManager<T, P>
- Defined in collections/aggregate/index.ts:169

Methods

boolean

boolean(
    metrics?: (
        | "count"
        | "totalTrue"
        | "totalFalse"
        | "percentageTrue"
        | "percentageFalse"
    )[],
): MetricsBoolean<P>
Define the metrics to be returned for a BOOL or BOOL_ARRAY property when aggregating over a collection.

If none of the arguments are provided then all metrics will be returned.
Parameters
- Optionalmetrics: ("count" | "totalTrue" | "totalFalse" | "percentageTrue" | "percentageFalse")[]
  The metrics to return.
Returns MetricsBoolean<P>
The metrics for the property.
- Defined in collections/aggregate/index.ts:189

date

date(
metrics?: ("mode" | "count" | "median" | "maximum" | "minimum")[],
): MetricsDate<P>
Define the metrics to be returned for a DATE or DATE_ARRAY property when aggregating over a collection.

If none of the arguments are provided then all metrics will be returned.
Parameters
- Optionalmetrics: ("mode" | "count" | "median" | "maximum" | "minimum")[]
  The metrics to return.
Returns MetricsDate<P>
The metrics for the property.
- Defined in collections/aggregate/index.ts:210

integer

integer(
    metrics?: (
        "mode"
        | "count"
        | "sum"
        | "mean"
        | "median"
        | "maximum"
        | "minimum"
    )[],
): MetricsInteger<P>
Define the metrics to be returned for an INT or INT_ARRAY property when aggregating over a collection.

If none of the arguments are provided then all metrics will be returned.
Parameters
- Optionalmetrics: ("mode" | "count" | "sum" | "mean" | "median" | "maximum" | "minimum")[]
  The metrics to return.
Returns MetricsInteger<P>
The metrics for the property.
- Defined in collections/aggregate/index.ts:229

number

number(
    metrics?: (
        "mode"
        | "count"
        | "sum"
        | "mean"
        | "median"
        | "maximum"
        | "minimum"
    )[],
): MetricsNumber<P>
Define the metrics to be returned for a NUMBER or NUMBER_ARRAY property when aggregating over a collection.

If none of the arguments are provided then all metrics will be returned.
Parameters
- Optionalmetrics: ("mode" | "count" | "sum" | "mean" | "median" | "maximum" | "minimum")[]
  The metrics to return.
Returns MetricsNumber<P>
The metrics for the property.
- Defined in collections/aggregate/index.ts:250

text

text(
metrics?: ("count" | "topOccurrencesOccurs" | "topOccurrencesValue")[],
minOccurrences?: number,
): MetricsText<P>
Define the metrics to be returned for a TEXT or TEXT_ARRAY property when aggregating over a collection.

If none of the arguments are provided then all metrics will be returned.
Parameters
- Optionalmetrics: ("count" | "topOccurrencesOccurs" | "topOccurrencesValue")[]
  The metrics to return.
- OptionalminOccurrences: number
  The how many top occurrences to return.
Returns MetricsText<P>
The metrics for the property.
- Defined in collections/aggregate/index.ts:280