Interface Metric

A tracked metric loosely based on the interfaces exposed by the prom-client module

interface Metric {
    decrement(value?: number): void;
    increment(value?: number): void;
    reset(): void;
    timer(): StopTimer;
    update(value: number): void;
}

Index

Methods

decrement increment reset timer update

Methods

decrement

decrement(value?: number): void
Decrement the metric by the passed value or 1
Parameters
- Optionalvalue: number
Returns void
- Defined in packages/interface/src/metrics.ts:61

increment

increment(value?: number): void
Increment the metric by the passed value or 1
Parameters
- Optionalvalue: number
Returns void
- Defined in packages/interface/src/metrics.ts:56

reset

reset(): void
Reset this metric to its default value

Returns void
- Defined in packages/interface/src/metrics.ts:66

timer

timer(): StopTimer
Start a timed metric, call the returned function to stop the timer

Returns StopTimer
- Defined in packages/interface/src/metrics.ts:72

update

update(value: number): void
Update the stored metric to the passed value
Parameters
- value: number
Returns void
- Defined in packages/interface/src/metrics.ts:51