nym21
4.6 KiB
brk-client / DateSeriesEndpoint
Interface: DateSeriesEndpoint<T>
Defined in: Developer/brk/modules/brk-client/index.js:1731
Type Parameters
T
T
Properties
fetch
fetch: (
arg?,options?) =>Promise<DateSeriesData<T>>
Defined in: Developer/brk/modules/brk-client/index.js:1737
Fetch all data
Parameters
arg?
options?
ClientFetchOptions<DateSeriesData<T>>
Returns
Promise<DateSeriesData<T>>
fetchCsv
fetchCsv: (
options?) =>Promise<string>
Defined in: Developer/brk/modules/brk-client/index.js:1738
Fetch all data as CSV
Parameters
options?
ClientFetchOptions<string>
Returns
Promise<string>
first
first: (
n) =>DateRangeBuilder<T>
Defined in: Developer/brk/modules/brk-client/index.js:1734
Get first n items
Parameters
n
number
Returns
get
get: (
index) =>DateSingleItemBuilder<T>
Defined in: Developer/brk/modules/brk-client/index.js:1732
Get single item at index or Date
Parameters
index
number | Date
Returns
last
last: (
n) =>DateRangeBuilder<T>
Defined in: Developer/brk/modules/brk-client/index.js:1735
Get last n items
Parameters
n
number
Returns
len
len: () =>
Promise<number>
Defined in: Developer/brk/modules/brk-client/index.js:1739
Get total number of data points
Returns
Promise<number>
path
path:
string
Defined in: Developer/brk/modules/brk-client/index.js:1742
The endpoint path
skip
skip: (
n) =>DateSkippedBuilder<T>
Defined in: Developer/brk/modules/brk-client/index.js:1736
Skip first n items, chain with take()
Parameters
n
number
Returns
slice
slice: (
start?,end?) =>DateRangeBuilder<T>
Defined in: Developer/brk/modules/brk-client/index.js:1733
Slice by index or Date
Parameters
start?
number | Date
end?
number | Date
Returns
then
then:
DateThenable<T>
Defined in: Developer/brk/modules/brk-client/index.js:1741
Thenable (await endpoint)
version
version: () =>
Promise<number>
Defined in: Developer/brk/modules/brk-client/index.js:1740
Get the current version of the series
Returns
Promise<number>