Class default

Index

Constructors

Properties

Methods

add set testGetNumRecordedErrors testGetValue

Constructors

constructor

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

Properties

`Private` #inner

#inner: InternalStringListMetricType

Methods

add

add(value): void
Adds a new string value to the list.

Note
- If the list is already of length MAX_LIST_LENGTH, record an error.
- Truncates the value if it is longer than MAX_STRING_LENGTH characters and records an error.
Parameters
- value: string
  The string to add.
Returns void
- Defined in src/core/metrics/types/string_list.ts:195

set

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

Note
Truncates the list if it is longer than MAX_LIST_LENGTH and records an error.

Truncates the value if it is longer than MAX_STRING_LENGTH characters and records an error.
Parameters
- value: string[]
  The list of strings to set the metric to.
Returns void
- Defined in src/core/metrics/types/string_list.ts:180

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_list.ts:224

testGetValue

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

Gets the currently stored value as a string array.

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_list.ts:210

Generated using TypeDoc