Interface Metric

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

Hierarchy

Metric

Index

Properties

decrement increment reset timer update

Properties

decrement

decrement: ((value?: number) => void)

Type declaration

- (value?: number): void
- Decrement the metric by the passed value or 1
  Parameters
  - Optional value: number
  Returns void

increment

increment: ((value?: number) => void)

Type declaration

- (value?: number): void
- Increment the metric by the passed value or 1
  Parameters
  - Optional value: number
  Returns void

reset

reset: (() => void)

Type declaration

- (): void
- Reset this metric to its default value
  
  Returns void

timer

timer: (() => StopTimer)

Type declaration

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

update

update: ((value: number) => void)

Type declaration

- (value: number): void
- Update the stored metric to the passed value
  Parameters
  - value: number
  Returns void