Class MultiMetricDataStore<T>

A metric data store containing data for multiple metrics for a single region.

Useful when fetching / storing a bunch of metrics that a single component needs.

Type Parameters

T = unknown

Hierarchy

MultiMetricDataStore

Index

Constructors

Properties

Accessors

Methods

assertFiniteNumbers dropTimeseries hasMetricData merge metricData

Constructors

constructor

new MultiMetricDataStore<T>(region: Region, data: MetricToDataMap<T>): MultiMetricDataStore<T>
Type Parameters
- T = unknown
Parameters
- region: Region
  
  The region for which we have stored metrics.
- data: MetricToDataMap<T>
Returns MultiMetricDataStore<T>
- Defined in src/metrics/data/MultiMetricDataStore.ts:19

Properties

`Private` data

data: MetricToDataMap<T>

`Readonly` region

region: Region

The region for which we have stored metrics.

Accessors

all

get all(): MetricData<unknown>[]
Returns the MetricData for every metric in the data store.

Returns MetricData<unknown>[]
- Defined in src/metrics/data/MultiMetricDataStore.ts:33

isEmpty

get isEmpty(): boolean
Whether this data store is empty.

Returns boolean
- Defined in src/metrics/data/MultiMetricDataStore.ts:26

Methods

assertFiniteNumbers

assertFiniteNumbers(): MultiMetricDataStore<number>
Ensures the data for all metrics is numeric.

Returns
This MultiMetricDataStore cast to MultiMetricDataStore<number>.

Returns MultiMetricDataStore<number>
- Defined in src/metrics/data/MultiMetricDataStore.ts:69

dropTimeseries

dropTimeseries(): MultiMetricDataStore<T>
Removes timeseries data for all metrics.

Returns
new MultiMetricDataStore object without timeseries data.

Returns MultiMetricDataStore<T>
- Defined in src/metrics/data/MultiMetricDataStore.ts:94

hasMetricData

hasMetricData(metric: string | Metric): boolean
Checks whether this data store contains data for the given metric.

Returns
Whether this data store contains data for the given metric.
Parameters
- metric: string | Metric
  
  The metric to check for data for.
Returns boolean
- Defined in src/metrics/data/MultiMetricDataStore.ts:59

merge

merge(other: MultiMetricDataStore<T>): MultiMetricDataStore<T>
Merges the provided data store into this one and returns the result.

Data from the provided data store takes precedence over any existing data.

Returns
The merged data store.
Parameters
- other: MultiMetricDataStore<T>
  
  The data store to merge into this one.
Returns MultiMetricDataStore<T>
- Defined in src/metrics/data/MultiMetricDataStore.ts:84

metricData

metricData(metric: string | Metric): MetricData<T>
Gets the MetricData for a particular metric.

Returns
The MetricData for the metric.
Parameters
- metric: string | Metric
  
  The metric to get data for.
Returns MetricData<T>
- Defined in src/metrics/data/MultiMetricDataStore.ts:43

Generated using TypeDoc