Options
All
  • Public
  • Public/Protected
  • All
Menu

Class default<SpecificExtraMap>

An event metric.

Type parameters

Hierarchy

  • default

Index

Constructors

Properties

Methods

  • record(extra?: SpecificExtraMap): void
  • Record an event.

    Parameters

    • Optional extra: SpecificExtraMap

      optional. Used for events where additional richer context is needed. The maximum length for string values is 100 bytes.

    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 | Event[]>
  • Test-only API

    Gets the currently stored events.

    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 | Event[]>

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

Generated using TypeDoc