Class TextMetric

Hierarchy

Metric<string, string>
- TextMetric

Index

Constructors

constructor

Properties

_inner

Methods

Constructors

constructor

new TextMetric(v: unknown): TextMetric

Overrides Metric.constructor
- Defined in src/core/metrics/types/text.ts:19
Parameters
- v: unknown
Returns TextMetric

Properties

Protected _inner

_inner: string

Methods

get

get(): string

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

Returns string
The metric value.

payload

payload(): string

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

Returns string
The metric value.

set

set(v: string): void

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

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

validate

validate(v: unknown): MetricValidationResult

Overrides Metric.validate
- Defined in src/core/metrics/types/text.ts:29
Validates that a given value is within bounds.

Parameters
- v: unknown
  
  The value to validate.
Returns MetricValidationResult
Whether or not v is valid text data.

validateOrThrow

validateOrThrow(v: unknown): string

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 string
v if it is valid.

Generated using TypeDoc