mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-05-19 22:34:46 -07:00
202 lines
4.3 KiB
Markdown
202 lines
4.3 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / DateSeriesEndpoint
|
|
|
|
# Interface: DateSeriesEndpoint\<T\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1617](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1617)
|
|
|
|
## Type Parameters
|
|
|
|
### T
|
|
|
|
`T`
|
|
|
|
## Properties
|
|
|
|
### fetch
|
|
|
|
> **fetch**: (`onValue?`) => `Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1623](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1623)
|
|
|
|
Fetch all data
|
|
|
|
#### Parameters
|
|
|
|
##### onValue?
|
|
|
|
(`value`) => `void`
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\>
|
|
|
|
***
|
|
|
|
### fetchCsv
|
|
|
|
> **fetchCsv**: () => `Promise`\<`string`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1624](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1624)
|
|
|
|
Fetch all data as CSV
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<`string`\>
|
|
|
|
***
|
|
|
|
### first
|
|
|
|
> **first**: (`n`) => [`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1620](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1620)
|
|
|
|
Get first n items
|
|
|
|
#### Parameters
|
|
|
|
##### n
|
|
|
|
`number`
|
|
|
|
#### Returns
|
|
|
|
[`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\>
|
|
|
|
***
|
|
|
|
### get
|
|
|
|
> **get**: (`index`) => [`DateSingleItemBuilder`](DateSingleItemBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1618](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1618)
|
|
|
|
Get single item at index or Date
|
|
|
|
#### Parameters
|
|
|
|
##### index
|
|
|
|
`number` \| `Date`
|
|
|
|
#### Returns
|
|
|
|
[`DateSingleItemBuilder`](DateSingleItemBuilder.md)\<`T`\>
|
|
|
|
***
|
|
|
|
### last
|
|
|
|
> **last**: (`n`) => [`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1621](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1621)
|
|
|
|
Get last n items
|
|
|
|
#### Parameters
|
|
|
|
##### n
|
|
|
|
`number`
|
|
|
|
#### Returns
|
|
|
|
[`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\>
|
|
|
|
***
|
|
|
|
### len
|
|
|
|
> **len**: () => `Promise`\<`number`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1625](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1625)
|
|
|
|
Get total number of data points
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<`number`\>
|
|
|
|
***
|
|
|
|
### path
|
|
|
|
> **path**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1628](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1628)
|
|
|
|
The endpoint path
|
|
|
|
***
|
|
|
|
### skip
|
|
|
|
> **skip**: (`n`) => [`DateSkippedBuilder`](DateSkippedBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1622](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1622)
|
|
|
|
Skip first n items, chain with take()
|
|
|
|
#### Parameters
|
|
|
|
##### n
|
|
|
|
`number`
|
|
|
|
#### Returns
|
|
|
|
[`DateSkippedBuilder`](DateSkippedBuilder.md)\<`T`\>
|
|
|
|
***
|
|
|
|
### slice
|
|
|
|
> **slice**: (`start?`, `end?`) => [`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1619](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1619)
|
|
|
|
Slice by index or Date
|
|
|
|
#### Parameters
|
|
|
|
##### start?
|
|
|
|
`number` \| `Date`
|
|
|
|
##### end?
|
|
|
|
`number` \| `Date`
|
|
|
|
#### Returns
|
|
|
|
[`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\>
|
|
|
|
***
|
|
|
|
### then
|
|
|
|
> **then**: [`DateThenable`](../type-aliases/DateThenable.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1627](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1627)
|
|
|
|
Thenable (await endpoint)
|
|
|
|
***
|
|
|
|
### version
|
|
|
|
> **version**: () => `Promise`\<`number`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1626](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1626)
|
|
|
|
Get the current version of the series
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<`number`\>
|