Class LocalGauge

Hierarchy

LocalSettable<number>
- LocalGauge

Implements

{ name: string; tags: Tags } & { set: any }
{ name: string; tags: Tags } & { set: any } & { increment: (val: T, tags?: Tags) => void }

Index

Constructors

constructor

Properties

Accessors

raw
value

Methods

Constructors

constructor

new LocalGauge(name: string, tags?: Tags): LocalGauge

Inherited from LocalSettable.constructor
- Defined in packages/core/src/apm/local/settable.ts:7
Parameters
- name: string
- Default value tags: Tags = {}
Returns LocalGauge

Properties

Protected _val

_val: Value<number | undefined>

Protected Readonly log

log: InternalLog = logger('LocalGauge')

Readonly name

name: string

Readonly tags

tags: Tags

Accessors

raw

get raw(): number

Overrides LocalSettable.raw
- Defined in packages/core/src/apm/local/gauge.ts:26
Returns number

value

get value(): Value<number | undefined>

Inherited from LocalSettable.value
- Defined in packages/core/src/apm/local/settable.ts:15
Returns Value<number | undefined>

Methods

decrement

decrement(value?: number, tags?: Tags): void

- Defined in packages/core/src/apm/local/gauge.ts:12
Parameters
- Default value value: number = 0
- Default value tags: Tags = {}
Returns void

increment

increment(value?: number, tags?: Tags): void

- Defined in packages/core/src/apm/local/gauge.ts:19
Parameters
- Default value value: number = 1
- Default value tags: Tags = {}
Returns void

reset

reset(): void

- Defined in packages/core/src/apm/local/gauge.ts:31
Returns void

set

set(value: number, tags?: Tags): Value<number | undefined>

Inherited from LocalSettable.set
- Defined in packages/core/src/apm/local/settable.ts:25
Parameters
- value: number
- Default value tags: Tags = {}
Returns Value<number | undefined>

Generated using TypeDoc