Class default

A string metric.

Record an Unicode string value with arbitrary content. Strings are length-limited to MAX_LENGTH_VALUE bytes.

Index

Constructors

Properties

Methods

set testGetNumRecordedErrors testGetValue

Constructors

constructor

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

Properties

`Private` #inner

#inner: InternalStringMetricType

Methods

set

set(value): void
Sets to the specified string value.

Note
Truncates the value if it is longer than MAX_STRING_LENGTH bytes and logs an error.
Parameters
- value: string
  the value to set.
Returns void
- Defined in src/core/metrics/types/string.ts:95

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/string.ts:124

testGetValue

testGetValue(ping?): undefined | string
Test-only API

Gets the currently stored value as a string.

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

Generated using TypeDoc