mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 14:49:58 -07:00
docs: update generated docs
This commit is contained in:
59
modules/brk-client/docs/interfaces/DateRangeBuilder.md
Normal file
59
modules/brk-client/docs/interfaces/DateRangeBuilder.md
Normal file
@@ -0,0 +1,59 @@
|
||||
[**brk-client**](../README.md)
|
||||
|
||||
***
|
||||
|
||||
[brk-client](../globals.md) / DateRangeBuilder
|
||||
|
||||
# Interface: DateRangeBuilder\<T\>
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1237](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1237)
|
||||
|
||||
## Type Parameters
|
||||
|
||||
### T
|
||||
|
||||
`T`
|
||||
|
||||
## Properties
|
||||
|
||||
### fetch
|
||||
|
||||
> **fetch**: (`onUpdate?`) => `Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\>
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1238](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1238)
|
||||
|
||||
Fetch the range
|
||||
|
||||
#### 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:1239](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1239)
|
||||
|
||||
Fetch as CSV
|
||||
|
||||
#### Returns
|
||||
|
||||
`Promise`\<`string`\>
|
||||
|
||||
***
|
||||
|
||||
### then
|
||||
|
||||
> **then**: [`DateThenable`](../type-aliases/DateThenable.md)\<`T`\>
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1240](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1240)
|
||||
|
||||
Thenable
|
||||
Reference in New Issue
Block a user