Class StaticValueDataProvider

Simple data provider that provides a static value for all regions. Mostly only useful for testing.

Example

dataReference: {
  providerId: "static",
  value: 42,
},

Hierarchy

SimpleMetricDataProviderBase
- StaticValueDataProvider

Index

Constructors

constructor

Properties

Methods

fetchData fetchDataForRegionAndMetric

Constructors

constructor

new StaticValueDataProvider(providerId: string): StaticValueDataProvider
Constructs a new MockDataProvider instance.
Parameters
- providerId: string
  
  A unique provider id to associate with the provider (e.g. "static"). This ID can be used from a MetricDataReference in a metric to reference the data from this provider.
Returns StaticValueDataProvider
Overrides SimpleMetricDataProviderBase.constructor
- Defined in src/metrics/data_providers/StaticValueDataProvider.ts:28

Properties

`Readonly` id

id: string

A unique provider id to associate with the provider (e.g. "mock"). This ID can be used from a MetricDataReference in a metric to reference the data from this provider.

Methods

fetchData

fetchData(regions: Region[], metrics: Metric[], includeTimeseries: boolean, metricCatalog: MetricCatalog): Promise<MultiRegionMultiMetricDataStore<unknown>>
Fetches all of the data for the specified regions and metrics, optionally including timeseries metric data if available.

Returns
The fetched data for the specified regions and metrics.
Parameters
- regions: Region[]
  
  One or more regions to fetch data for.
- metrics: Metric[]
  
  One or more metrics to fetch data for.
- includeTimeseries: boolean
  
  Whether to fetch timeseries data.
- metricCatalog: MetricCatalog
  
  The metric catalog using this data provider. The data provider can call back into the catalog if it needs to fetch dependent data.
Returns Promise<MultiRegionMultiMetricDataStore<unknown>>
Inherited from SimpleMetricDataProviderBase.fetchData
- Defined in src/metrics/data_providers/SimpleMetricDataProviderBase.ts:40

fetchDataForRegionAndMetric

fetchDataForRegionAndMetric(region: Region, metric: Metric, includeTimeseries: boolean): Promise<MetricData<unknown>>
Method to be overridden by subclasses to fetch the specified MetricData.

Returns
The MetricData for the given metric and region.
Parameters
- region: Region
  
  The region to get data for.
- metric: Metric
  
  The metric to get data for.
- includeTimeseries: boolean
  
  Whether to get timeseries data.
Returns Promise<MetricData<unknown>>
Overrides SimpleMetricDataProviderBase.fetchDataForRegionAndMetric
- Defined in src/metrics/data_providers/StaticValueDataProvider.ts:32

Class StaticValueDataProvider

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

providerId: string

Returns StaticValueDataProvider

Properties

`Readonly` id

Methods

fetchData

Returns

Parameters

regions: Region[]

metrics: Metric[]

includeTimeseries: boolean

metricCatalog: MetricCatalog

Returns Promise<MultiRegionMultiMetricDataStore<unknown>>

fetchDataForRegionAndMetric

Returns

Parameters

region: Region

metric: Metric

includeTimeseries: boolean

Returns Promise<MetricData<unknown>>

Settings

Member Visibility

Theme

Class StaticValueDataProvider

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

providerId: string

Returns StaticValueDataProvider

Properties

Readonly id

Methods

fetchData

Returns

Parameters

regions: Region[]

metrics: Metric[]

includeTimeseries: boolean

metricCatalog: MetricCatalog

Returns Promise<MultiRegionMultiMetricDataStore<unknown>>

fetchDataForRegionAndMetric

Returns

Parameters

region: Region

metric: Metric

includeTimeseries: boolean

Returns Promise<MetricData<unknown>>

Settings

Member Visibility

Theme

`Readonly` id