io.Connect Desktop Documentation - @interopio/desktop - Metrics - StringMetric

String 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⚓︎	string	x		Returns the value of the metric.

1 Methods

update()⚓︎

(value: string) => Promise<void>

Updates the value of the metric.

Parameters (1)

Name	Type	Required	Description
value⚓︎	string		Value with which to update the metric.