@interopio/desktop API Reference

Number metric.

Properties (8)

Property Type Default Required Description
description⚓︎ string x x

Returns the description of the metric.
id⚓︎ string x

Returns the ID of the metric.
name⚓︎ string x

Returns the name of the metric.
path⚓︎ string[] x

An array of parent system names, starting with the root system name.
repo⚓︎ Repository x

Returns the repository of the metric.
system⚓︎ System x

Returns the system of the metric.
type⚓︎ number x

Returns the type of the metric.
value⚓︎ number x

Returns the value of the metric.

5 Methods

decrement()⚓︎

() => void

Decrements the value of the metric by 1

decrementBy()⚓︎

(num: number) => void

Decrements the value of the metric by the specified number.

Parameters (1)

Name Type Required Description
num⚓︎ number

Number by which to decrement the metric.

increment()⚓︎

() => void

Increments the value of the metric by 1.

incrementBy()⚓︎

(num: number) => void

Increments the value of the metric by the specified number.

Parameters (1)

Name Type Required Description
num⚓︎ number

Number by which to increment the metric.

update()⚓︎

(value: number) => Promise<void>

Updates the value of the metric.

Parameters (1)

Name Type Required Description
value⚓︎ number

Value with which to update the metric.