Class default<SpecificExtraMap>

An event metric.

Type Parameters

SpecificExtraMap extends ExtraMap = ExtraMap

Hierarchy

default

Index

Constructors

Properties

Methods

record testGetNumRecordedErrors testGetValue

Constructors

constructor

new default<SpecificExtraMap>(meta, allowedExtraKeys?): default<SpecificExtraMap>
Type Parameters
- SpecificExtraMap extends ExtraMap = ExtraMap
Parameters
- meta: CommonMetricData
- Optional allowedExtraKeys: string[]
Returns default<SpecificExtraMap>
- Defined in src/core/metrics/types/event.ts:125

Properties

`Private` #inner

#inner: InternalEventMetricType<ExtraMap>

Methods

record

record(extra?): void
Record an event.
Parameters
- Optional extra: SpecificExtraMap
  optional. Used for events where additional richer context is needed. The maximum length for string values is 100 bytes.
Returns void
- Defined in src/core/metrics/types/event.ts:135

testGetNumRecordedErrors

testGetNumRecordedErrors(errorType, ping?): number
Test-only API

Returns the number of errors recorded for the given metric.
Parameters
- errorType: string
  The type of the error recorded.
- ping: string = ...
  represents the name of the ping to retrieve the metric for. Defaults to the first value in sendInPings.
Returns number
the number of errors recorded for the metric.
- Defined in src/core/metrics/types/event.ts:164

testGetValue

testGetValue(ping?): undefined | Event[]
Test-only API

Gets the currently stored events.

This doesn't clear the stored value.
Parameters
- ping: string = ...
  the ping from which we want to retrieve this metrics value from. Defaults to the first value in sendInPings.
Returns undefined | Event[]
The value found in storage or undefined if nothing was found.
- Defined in src/core/metrics/types/event.ts:150

Generated using TypeDoc