brk/modules/brk-client/docs/interfaces/MetricEndpoint.md

brk-client

---

brk-client / MetricEndpoint

Interface: MetricEndpoint<T>

Defined in: Developer/brk/modules/brk-client/index.js:556

Type Parameters

T

T

Properties

get()

get: (onUpdate?) => Promise<MetricData<T>>

Defined in: Developer/brk/modules/brk-client/index.js:557

Fetch all data points

Parameters

onUpdate?

(value) => void

Returns

Promise<MetricData<T>>

---

path

path: string

Defined in: Developer/brk/modules/brk-client/index.js:559

The endpoint path

---

range()

range: (from?, to?, onUpdate?) => Promise<MetricData<T>>

Defined in: Developer/brk/modules/brk-client/index.js:558

Fetch data in range

Parameters

from?

number

to?

number

onUpdate?

(value) => void

Returns

Promise<MetricData<T>>