Options
All
  • Public
  • Public/Protected
  • All
Menu

A quantity metric.

Used to store quantity. The value can only be non-negative.

Hierarchy

  • default

Index

Constructors

Properties

#inner: InternalQuantityMetricType

Methods

  • set(value: number): void
  • Sets to the specified quantity value. Logs an warning if the value is negative.

    Parameters

    • value: number

      the value to set. Must be non-negative

    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 | number>
  • Test-only API.**

    Gets the currently stored value as a number.

    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 | number>

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

Generated using TypeDoc