Module core/metrics/utils

Index

Functions

Functions

createMetric

createMetric(type: string, v: unknown): Metric<JSONValue, JSONValue>

- Defined in src/core/metrics/utils.ts:28
A metric factory function.
throws
- In case type is not listed in the Context.supportedMetrics;
- In case v is not in the correct representation for the wanted metric type.
Parameters
- type: string
  
  The type of the metric to create.
- v: unknown
  
  The value with which to instantiate the metric.
Returns Metric<JSONValue, JSONValue>
A metric instance.

validateMetricInternalRepresentation

validateMetricInternalRepresentation<T>(type: string, v: unknown): v is T

- Defined in src/core/metrics/utils.ts:49
Validates that a given value is in the correct internal representation format for a metric of a given type.

Type parameters
- T: JSONValue
Parameters
- type: string
  
  The type of the metric to validate
- v: unknown
  
  The value to verify
Returns v is T
Whether or not v is of the correct type.

validatePositiveInteger

validatePositiveInteger(v: unknown, zeroIsValid?: boolean): MetricValidationResult

- Defined in src/core/metrics/utils.ts:69
Validates that a given value is a positive integer.

Parameters
- v: unknown
  
  The value to validate
- zeroIsValid: boolean = true
  
  Whether or not to consider 0 a valid value, defaults to true
Returns MetricValidationResult
A validation result

validateString

validateString(v: unknown): MetricValidationResult

- Defined in src/core/metrics/utils.ts:95
Validates that a given value is a string.

Parameters
- v: unknown
  
  The value to validate
Returns MetricValidationResult
A validation result

Generated using TypeDoc