Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-05-19 22:34:46 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update generated docs

Browse Source
This commit is contained in:
nym21
2026-05-08 00:35:52 +02:00
parent 6e8be1af22
commit 1643cf86ed
606 changed files with 5386 additions and 4545 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
modules/brk-client/docs/interfaces/DateSkippedBuilder.md
View File

@@ -6,7 +6,7 @@
# Interface: DateSkippedBuilder\<T\>
Defined in: [Developer/brk/modules/brk-client/index.js:1558](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1558)
Defined in: [Developer/brk/modules/brk-client/index.js:1652](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1652)
## Type Parameters
@@ -18,15 +18,15 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1558](https://github.com/
### fetch
> **fetch**: (`onUpdate?`) => `Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\>
> **fetch**: (`onValue?`) => `Promise`\<[`DateSeriesData`](../type-aliases/DateSeriesData.md)\<`T`\>\>
Defined in: [Developer/brk/modules/brk-client/index.js:1560](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1560)
Defined in: [Developer/brk/modules/brk-client/index.js:1654](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1654)
Fetch from skipped position to end
#### Parameters
##### onUpdate?
##### onValue?
(`value`) => `void`
@@ -40,7 +40,7 @@ Fetch from skipped position to end
> **fetchCsv**: () => `Promise`\<`string`\>
Defined in: [Developer/brk/modules/brk-client/index.js:1561](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1561)
Defined in: [Developer/brk/modules/brk-client/index.js:1655](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1655)
Fetch as CSV
@@ -54,7 +54,7 @@ Fetch as CSV
> **take**: (`n`) => [`DateRangeBuilder`](DateRangeBuilder.md)\<`T`\>
Defined in: [Developer/brk/modules/brk-client/index.js:1559](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1559)
Defined in: [Developer/brk/modules/brk-client/index.js:1653](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1653)
Take n items after skipped position
@@ -74,6 +74,6 @@ Take n items after skipped position
> **then**: [`DateThenable`](../type-aliases/DateThenable.md)\<`T`\>
Defined in: [Developer/brk/modules/brk-client/index.js:1562](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1562)
Defined in: [Developer/brk/modules/brk-client/index.js:1656](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1656)
Thenable