Class Metric<InternalRepresentation, PayloadRepresentation>`Abstract`

The Metric class describes the shared behaviour amongst concrete metrics.

A concrete metric will always have two possible representations:

InternalRepresentation
- Is the format in which this metric will be stored in memory.
- This format may contain extra metadata, in order to allow deserializing of this data for testing purposes.
PayloadRepresentation
- Is the format in which this metric will be represented in the ping payload.
- This format must be the exact same as described in the Glean schema.

Type Parameters

InternalRepresentation extends JSONValue
PayloadRepresentation extends JSONValue

Hierarchy (view full)

Metric

Index

Constructors

Properties

Methods

get payload set validate validateOrThrow

Constructors

constructor

new Metric<InternalRepresentation, PayloadRepresentation>(v): Metric<InternalRepresentation, PayloadRepresentation>
Type Parameters
- InternalRepresentation extends JSONValue
- PayloadRepresentation extends JSONValue
Parameters
- v: unknown
Returns Metric<InternalRepresentation, PayloadRepresentation>
- Defined in src/core/metrics/metric.ts:49

Properties

`Protected` inner

inner: InternalRepresentation

Methods

get

get(): InternalRepresentation
Gets this metrics value in its internal representation.

Returns InternalRepresentation
The metric value.
- Defined in src/core/metrics/metric.ts:58

`Abstract` payload

payload(): PayloadRepresentation
Gets this metrics value in its payload representation.

Returns PayloadRepresentation
The metric value.
- Defined in src/core/metrics/metric.ts:105

set

set(v): void
Sets this metrics value.
Parameters
- v: InternalRepresentation
  The value to set.
Returns void
- Defined in src/core/metrics/metric.ts:67

`Abstract` validate

validate(v): MetricValidationResult
Validates that a given value is in the correct format for this metrics internal representation.

Note
This function should only check for validations that would prevent a metric from being recorded.
Parameters
- v: unknown
  The value to verify.
Returns MetricValidationResult
Whether or not validation was successful.
- Defined in src/core/metrics/metric.ts:98

validateOrThrow

validateOrThrow(v): InternalRepresentation
Validates a given value using the validation function and throws in case it is not valid.
Parameters
- v: unknown
  The value to verify.
Returns InternalRepresentation
v if it is valid.
- Defined in src/core/metrics/metric.ts:77

Generated using TypeDoc