Options
All
  • Public
  • Public/Protected
  • All
Menu

A string metric.

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

Hierarchy

  • default

Index

Constructors

Properties

Methods

  • set(value: string): 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

  • testGetNumRecordedErrors(errorType: string, ping?: string): Promise<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 Promise<number>

    the number of errors recorded for the metric.

  • testGetValue(ping?: string): Promise<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 Promise<undefined | string>

    The value found in storage or undefined if nothing was found.

Generated using TypeDoc