nym21
4.4 KiB
brk-client / SeriesEndpoint
Interface: SeriesEndpoint<T>
Defined in: Developer/brk/modules/brk-client/index.js:1715
Type Parameters
T
T
Properties
fetch
fetch: (
arg?,options?) =>Promise<SeriesData<T>>
Defined in: Developer/brk/modules/brk-client/index.js:1721
Fetch all data
Parameters
arg?
options?
ClientFetchOptions<SeriesData<T>>
Returns
Promise<SeriesData<T>>
fetchCsv
fetchCsv: (
options?) =>Promise<string>
Defined in: Developer/brk/modules/brk-client/index.js:1722
Fetch all data as CSV
Parameters
options?
ClientFetchOptions<string>
Returns
Promise<string>
first
first: (
n) =>RangeBuilder<T>
Defined in: Developer/brk/modules/brk-client/index.js:1718
Get first n items
Parameters
n
number
Returns
RangeBuilder<T>
get
get: (
index) =>SingleItemBuilder<T>
Defined in: Developer/brk/modules/brk-client/index.js:1716
Get single item at index
Parameters
index
number
Returns
last
last: (
n) =>RangeBuilder<T>
Defined in: Developer/brk/modules/brk-client/index.js:1719
Get last n items
Parameters
n
number
Returns
RangeBuilder<T>
len
len: () =>
Promise<number>
Defined in: Developer/brk/modules/brk-client/index.js:1723
Get total number of data points
Returns
Promise<number>
path
path:
string
Defined in: Developer/brk/modules/brk-client/index.js:1726
The endpoint path
skip
skip: (
n) =>SkippedBuilder<T>
Defined in: Developer/brk/modules/brk-client/index.js:1720
Skip first n items, chain with take()
Parameters
n
number
Returns
slice
slice: (
start?,end?) =>RangeBuilder<T>
Defined in: Developer/brk/modules/brk-client/index.js:1717
Slice by index
Parameters
start?
number
end?
number
Returns
RangeBuilder<T>
then
then:
Thenable<T>
Defined in: Developer/brk/modules/brk-client/index.js:1725
Thenable (await endpoint)
version
version: () =>
Promise<number>
Defined in: Developer/brk/modules/brk-client/index.js:1724
Get the current version of the series
Returns
Promise<number>