Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-04-24 14:49:58 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update generated docs

Browse Source
This commit is contained in:
nym21
2026-03-23 16:45:58 +01:00
parent c4c0004c4a
commit 0d2deb1b63
780 changed files with 23664 additions and 18747 deletions
Download Patch File Download Diff File Expand all files Collapse all files

173
modules/brk-client/docs/interfaces/DateSeriesEndpoint.md Normal file
View File

@@ -0,0 +1,173 @@
[**brk-client**](../README.md)
***
[brk-client](../globals.md) / DateSeriesEndpoint
# Interface: DateSeriesEndpoint\<T\>
Defined in: [Developer/brk/modules/brk-client/index.js:1191](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1191)
## Type Parameters
### T
`T`
## Properties
### fetch
> **fetch**: (`onUpdate?`) => `Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\>
Defined in: [Developer/brk/modules/brk-client/index.js:1197](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1197)
Fetch all data
#### Parameters
##### onUpdate?
(`value`) => `void`
#### Returns
`Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\>
***
### fetchCsv
> **fetchCsv**: () => `Promise`\<`string`\>
Defined in: [Developer/brk/modules/brk-client/index.js:1198](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1198)
Fetch all data as CSV
#### Returns
`Promise`\<`string`\>
***
### first
> **first**: (`n`) => [`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\>
Defined in: [Developer/brk/modules/brk-client/index.js:1194](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1194)
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:1192](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1192)
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:1195](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1195)
Get last n items
#### Parameters
##### n
`number`
#### Returns
[`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\>
***
### path
> **path**: `string`
Defined in: [Developer/brk/modules/brk-client/index.js:1200](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1200)
The endpoint path
***
### skip
> **skip**: (`n`) => [`DateSkippedBuilder`](DateSkippedBuilder.md)\<`T`\>
Defined in: [Developer/brk/modules/brk-client/index.js:1196](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1196)
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:1193](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1193)
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:1199](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1199)
Thenable (await endpoint)