@ralphschuler.prom metrics decorator.<internal>.Gauge.Internal

Interface: Internal<T>

<internal>.Gauge.Internal

Type parameters

Name	Type
T	extends string

Table of contents

Methods

• dec
• inc
• set
• setToCurrentTime
• startTimer

Methods

dec

▸ dec(value?): void

Decrement with value

Parameters

Name	Type	Description
value?	number	The value to decrement with

Returns

void

Defined in

node_modules/prom-client/index.d.ts:363

---

inc

▸ inc(value?): void

Increment gauge with value

Parameters

Name	Type	Description
value?	number	The value to increment with

Returns

void

Defined in

node_modules/prom-client/index.d.ts:357

---

set

▸ set(value): void

Set gauges value

Parameters

Name	Type	Description
value	number	The value to set

Returns

void

Defined in

node_modules/prom-client/index.d.ts:369

---

setToCurrentTime

▸ setToCurrentTime(): void

Set gauge value to current epoch time in ms

Returns

void

Defined in

node_modules/prom-client/index.d.ts:374

---

startTimer

▸ startTimer(): (labels?: Partial<Record<T, string | number>>) => number

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

Returns

fn

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

▸ (labels?): number

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

Parameters

Name	Type
labels?	Partial<Record<T, string | number>>

Returns

number

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

Defined in

node_modules/prom-client/index.d.ts:382