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

brk-client

---

brk-client / MetricEndpointBuilder

Interface: MetricEndpointBuilder<T>

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

Type Parameters

T

T

Properties

fetch()

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

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

Fetch all data

Parameters

onUpdate?

(value) => void

Returns

Promise<MetricData<T>>

---

fetchCsv()

fetchCsv: () => Promise<string>

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

Fetch all data as CSV

Returns

Promise<string>

---

first()

first: (n) => RangeBuilder<T>

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

Get first n items

Parameters

n

number

Returns

RangeBuilder<T>

---

get()

get: (index) => SingleItemBuilder<T>

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

Get single item at index

Parameters

index

number

Returns

SingleItemBuilder<T>

---

last()

last: (n) => RangeBuilder<T>

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

Get last n items

Parameters

n

number

Returns

RangeBuilder<T>

---

path

path: string

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

The endpoint path

---

skip()

skip: (n) => SkippedBuilder<T>

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

Skip first n items, chain with take()

Parameters

n

number

Returns

SkippedBuilder<T>

---

slice()

slice: (start?, end?) => RangeBuilder<T>

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

Slice like Array.slice

Parameters

start?

number

end?

number

Returns

RangeBuilder<T>

---

then

then: Thenable<T>

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

Thenable (await endpoint)