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

brk-client

---

brk-client / DateSeriesEndpoint

Interface: DateSeriesEndpoint<T>

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

Type Parameters

T

T

Properties

fetch

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

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

Fetch all data

Parameters

onUpdate?

(value) => void

Returns

Promise<DateSeriesData<T>>

---

fetchCsv

fetchCsv: () => Promise<string>

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

Fetch all data as CSV

Returns

Promise<string>

---

first

first: (n) => DateRangeBuilder<T>

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

Get first n items

Parameters

n

number

Returns

DateRangeBuilder<T>

---

get

get: (index) => DateSingleItemBuilder<T>

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

Get single item at index or Date

Parameters

index

number | Date

Returns

DateSingleItemBuilder<T>

---

last

last: (n) => DateRangeBuilder<T>

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

Get last n items

Parameters

n

number

Returns

DateRangeBuilder<T>

---

path

path: string

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

The endpoint path

---

skip

skip: (n) => DateSkippedBuilder<T>

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

Skip first n items, chain with take()

Parameters

n

number

Returns

DateSkippedBuilder<T>

---

slice

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

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

Slice by index or Date

Parameters

start?

number | Date

end?

number | Date

Returns

DateRangeBuilder<T>

---

then

then: DateThenable<T>

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

Thenable (await endpoint)