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

brk-client

---

brk-client / SeriesEndpoint

Interface: SeriesEndpoint<T>

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

Type Parameters

T

T

Properties

fetch

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

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

Fetch all data

Parameters

onUpdate?

(value) => void

Returns

Promise<SeriesData<T>>

---

fetchCsv

fetchCsv: () => Promise<string>

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

Fetch all data as CSV

Returns

Promise<string>

---

first

first: (n) => RangeBuilder<T>

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

Get first n items

Parameters

n

number

Returns

RangeBuilder<T>

---

get

get: (index) => SingleItemBuilder<T>

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

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:1345

Get last n items

Parameters

n

number

Returns

RangeBuilder<T>

---

path

path: string

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

The endpoint path

---

skip

skip: (n) => SkippedBuilder<T>

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

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:1343

Slice by index

Parameters

start?

number

end?

number

Returns

RangeBuilder<T>

---

then

then: Thenable<T>

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

Thenable (await endpoint)