Interface Internal<T>

interface Internal<T> {
    dec(value?): void;
    inc(value?): void;
    set(value): void;
    setToCurrentTime(): void;
    startTimer(): ((labels?) => number);
}

Type Parameters

  • T extends string

Methods

dec inc set setToCurrentTime startTimer

Methods

dec

  • dec(value?): void

  • Decrement with value

    Parameters

    • Optional value: number

      The value to decrement with

    Returns void

inc

  • inc(value?): void

  • Increment gauge with value

    Parameters

    • Optional value: number

      The value to increment with

    Returns void

set

  • set(value): void

  • Set gauges value

    Parameters

    • value: number

      The value to set

    Returns void

setToCurrentTime

  • setToCurrentTime(): void

  • Set gauge value to current epoch time in ms

    Returns void

startTimer

  • startTimer(): ((labels?) => number)

  • Start a timer. Calling the returned function will set the gauge's value to the observed duration in seconds.

    Returns ((labels?) => number)

    Function to invoke when timer should be stopped. The value it returns is the timed duration.

      • (labels?): number

      • Parameters

        • Optional labels: Partial<Record<T, string | number>>

        Returns number

Settings

Member Visibility

Theme

On This Page

decincsetsetToCurrentTimestartTimer