Class default

Index

Constructors

Properties

Methods

addToDenominator addToNumerator testGetNumRecordedErrors testGetValue

Constructors

constructor

new default(meta): default
Parameters
- meta: CommonMetricData
Returns default
- Defined in src/core/metrics/types/rate.ts:160

Properties

`Private` #inner

#inner: InternalRateMetricType

Methods

addToDenominator

addToDenominator(amount): void
Increases the denominator by amount.

Note
Records an InvalidValue error if the amount is negative.
Parameters
- amount: number
  The amount to increase by. Should be non-negative.
Returns void
- Defined in src/core/metrics/types/rate.ts:186

addToNumerator

addToNumerator(amount): void
Increases the numerator by amount.

Note
Records an InvalidValue error if the amount is negative.
Parameters
- amount: number
  The amount to increase by. Should be non-negative.
Returns void
- Defined in src/core/metrics/types/rate.ts:173

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/rate.ts:219

testGetValue

testGetValue(ping?): undefined | Rate
Test-only API.**

Gets the currently stored value as an object.

Note
This function will return the Rate for convenience.

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 | Rate
The value found in storage or undefined if nothing was found.
- Defined in src/core/metrics/types/rate.ts:205

Generated using TypeDoc