mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 14:49:58 -07:00
174 lines
3.5 KiB
Markdown
174 lines
3.5 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / SeriesEndpoint
|
|
|
|
# Interface: SeriesEndpoint\<T\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1177](https://github.com/bitcoinresearchkit/brk/blob/19d4a193ffb7d8bbcaf9d0ccaccf8e90edff9e28/modules/brk-client/index.js#L1177)
|
|
|
|
## Type Parameters
|
|
|
|
### T
|
|
|
|
`T`
|
|
|
|
## Properties
|
|
|
|
### fetch
|
|
|
|
> **fetch**: (`onUpdate?`) => `Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1183](https://github.com/bitcoinresearchkit/brk/blob/19d4a193ffb7d8bbcaf9d0ccaccf8e90edff9e28/modules/brk-client/index.js#L1183)
|
|
|
|
Fetch all data
|
|
|
|
#### Parameters
|
|
|
|
##### onUpdate?
|
|
|
|
(`value`) => `void`
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\>
|
|
|
|
***
|
|
|
|
### fetchCsv
|
|
|
|
> **fetchCsv**: () => `Promise`\<`string`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1184](https://github.com/bitcoinresearchkit/brk/blob/19d4a193ffb7d8bbcaf9d0ccaccf8e90edff9e28/modules/brk-client/index.js#L1184)
|
|
|
|
Fetch all data as CSV
|
|
|
|
#### Returns
|
|
|
|
`Promise`\<`string`\>
|
|
|
|
***
|
|
|
|
### first
|
|
|
|
> **first**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1180](https://github.com/bitcoinresearchkit/brk/blob/19d4a193ffb7d8bbcaf9d0ccaccf8e90edff9e28/modules/brk-client/index.js#L1180)
|
|
|
|
Get first n items
|
|
|
|
#### Parameters
|
|
|
|
##### n
|
|
|
|
`number`
|
|
|
|
#### Returns
|
|
|
|
[`RangeBuilder`](RangeBuilder.md)\<`T`\>
|
|
|
|
***
|
|
|
|
### get
|
|
|
|
> **get**: (`index`) => [`SingleItemBuilder`](SingleItemBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1178](https://github.com/bitcoinresearchkit/brk/blob/19d4a193ffb7d8bbcaf9d0ccaccf8e90edff9e28/modules/brk-client/index.js#L1178)
|
|
|
|
Get single item at index
|
|
|
|
#### Parameters
|
|
|
|
##### index
|
|
|
|
`number`
|
|
|
|
#### Returns
|
|
|
|
[`SingleItemBuilder`](SingleItemBuilder.md)\<`T`\>
|
|
|
|
***
|
|
|
|
### last
|
|
|
|
> **last**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1181](https://github.com/bitcoinresearchkit/brk/blob/19d4a193ffb7d8bbcaf9d0ccaccf8e90edff9e28/modules/brk-client/index.js#L1181)
|
|
|
|
Get last n items
|
|
|
|
#### Parameters
|
|
|
|
##### n
|
|
|
|
`number`
|
|
|
|
#### Returns
|
|
|
|
[`RangeBuilder`](RangeBuilder.md)\<`T`\>
|
|
|
|
***
|
|
|
|
### path
|
|
|
|
> **path**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1186](https://github.com/bitcoinresearchkit/brk/blob/19d4a193ffb7d8bbcaf9d0ccaccf8e90edff9e28/modules/brk-client/index.js#L1186)
|
|
|
|
The endpoint path
|
|
|
|
***
|
|
|
|
### skip
|
|
|
|
> **skip**: (`n`) => [`SkippedBuilder`](SkippedBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1182](https://github.com/bitcoinresearchkit/brk/blob/19d4a193ffb7d8bbcaf9d0ccaccf8e90edff9e28/modules/brk-client/index.js#L1182)
|
|
|
|
Skip first n items, chain with take()
|
|
|
|
#### Parameters
|
|
|
|
##### n
|
|
|
|
`number`
|
|
|
|
#### Returns
|
|
|
|
[`SkippedBuilder`](SkippedBuilder.md)\<`T`\>
|
|
|
|
***
|
|
|
|
### slice
|
|
|
|
> **slice**: (`start?`, `end?`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1179](https://github.com/bitcoinresearchkit/brk/blob/19d4a193ffb7d8bbcaf9d0ccaccf8e90edff9e28/modules/brk-client/index.js#L1179)
|
|
|
|
Slice by index
|
|
|
|
#### Parameters
|
|
|
|
##### start?
|
|
|
|
`number`
|
|
|
|
##### end?
|
|
|
|
`number`
|
|
|
|
#### Returns
|
|
|
|
[`RangeBuilder`](RangeBuilder.md)\<`T`\>
|
|
|
|
***
|
|
|
|
### then
|
|
|
|
> **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1185](https://github.com/bitcoinresearchkit/brk/blob/19d4a193ffb7d8bbcaf9d0ccaccf8e90edff9e28/modules/brk-client/index.js#L1185)
|
|
|
|
Thenable (await endpoint)
|