Class CounterMetric

Hierarchy

Metric<number, number>
- CounterMetric

Index

Constructors

constructor

Properties

_inner

Methods

Constructors

constructor

new CounterMetric(v: unknown): CounterMetric

Overrides Metric.constructor
- Defined in src/core/metrics/types/counter.ts:18
Parameters
- v: unknown
Returns CounterMetric

Properties

Protected _inner

_inner: number

Methods

get

get(): number

Inherited from Metric.get
- Defined in src/core/metrics/metric.ts:62
Gets this metrics value in its internal representation.

Returns number
The metric value.

payload

payload(): number

Overrides Metric.payload
- Defined in src/core/metrics/types/counter.ts:26
Gets this metrics value in its payload representation.

Returns number
The metric value.

saturatingAdd

saturatingAdd(amount: unknown): void

- Defined in src/core/metrics/types/counter.ts:30
Parameters
- amount: unknown
Returns void

set

set(v: number): void

Inherited from Metric.set
- Defined in src/core/metrics/metric.ts:71
Sets this metrics value.

Parameters
- v: number
  
  The value to set.
Returns void

validate

validate(v: unknown): MetricValidationResult

Overrides Metric.validate
- Defined in src/core/metrics/types/counter.ts:22
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
Returns MetricValidationResult
Whether or not validation was successfull.

validateOrThrow

validateOrThrow(v: unknown): number

Inherited from Metric.validateOrThrow
- Defined in src/core/metrics/metric.ts:81
Validates a given value using the validation function and throws in case it is not valid.

Parameters
- v: unknown
  
  The value to verify.
Returns number
v if it is valid.

Generated using TypeDoc