Class DatetimeMetric

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.

Hierarchy (view full)

Metric<DatetimeInternalRepresentation, string>
- DatetimeMetric

Index

Constructors

Properties

Accessors

date dateISOString timeUnit timezone

Methods

get payload set validate validateOrThrow fromDate fromRawDatetime

Constructors

constructor

new DatetimeMetric(v): DatetimeMetric
Parameters
- v: unknown
Returns DatetimeMetric
Overrides Metric.constructor
- Defined in src/core/metrics/types/datetime.ts:45

Properties

`Protected` inner

inner: DatetimeInternalRepresentation

Accessors

date

get date(): Date
Gets the datetime data as a Date object.

Note
The object created here will be relative to local time. If the timezone at the time of recording is different, the timezone offset will be applied before transforming to an object.

Returns Date
A date object.
- Defined in src/core/metrics/types/datetime.ts:84

`Private` dateISOString

get dateISOString(): string
Returns string
- Defined in src/core/metrics/types/datetime.ts:96

`Private` timeUnit

get timeUnit(): default
Returns default
- Defined in src/core/metrics/types/datetime.ts:92

`Private` timezone

get timezone(): number
Returns number
- Defined in src/core/metrics/types/datetime.ts:88

Methods

get

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

Returns DatetimeInternalRepresentation
The metric value.
Inherited from Metric.get
- Defined in src/core/metrics/metric.ts:58

payload

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

For this metric, the payload is the timezone aware ISO date string truncated to the time unit given at the time of recording.

Note
The timezone of the final string is the timezone at the time of recording.

Returns string
The metric value.
Overrides Metric.payload
- Defined in src/core/metrics/types/datetime.ts:137

set

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

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.
Overrides Metric.validate
- Defined in src/core/metrics/types/datetime.ts:100

validateOrThrow

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

`Static` fromDate

fromDate(v, timeUnit): DatetimeMetric
Parameters
- v: unknown
- timeUnit: default
Returns DatetimeMetric
- Defined in src/core/metrics/types/datetime.ts:49

`Static` fromRawDatetime

fromRawDatetime(isoString, timezoneOffset, timeUnit): DatetimeMetric
Parameters
- isoString: string
- timezoneOffset: number
- timeUnit: default
Returns DatetimeMetric
- Defined in src/core/metrics/types/datetime.ts:61

Generated using TypeDoc