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

20
modules/brk-client/docs/interfaces/SkippedBuilder.md
View File

@@ -6,7 +6,7 @@
# Interface: SkippedBuilder\<T\>
Defined in: [Developer/brk/modules/brk-client/index.js:1053](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1053)
Defined in: [Developer/brk/modules/brk-client/index.js:1217](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1217)
## Type Parameters
@@ -16,11 +16,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1053](https://github.com/
## Properties
### fetch()
### fetch
> **fetch**: (`onUpdate?`) => `Promise`\<[`MetricData`](MetricData.md)\<`T`\>\>
> **fetch**: (`onUpdate?`) => `Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\>
Defined in: [Developer/brk/modules/brk-client/index.js:1055](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1055)
Defined in: [Developer/brk/modules/brk-client/index.js:1219](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1219)
Fetch from skipped position to end
@@ -32,15 +32,15 @@ Fetch from skipped position to end
#### Returns
`Promise`\<[`MetricData`](MetricData.md)\<`T`\>\>
`Promise`\<[`SeriesData`](../type-aliases/SeriesData.md)\<`T`\>\>
***
### fetchCsv()
### fetchCsv
> **fetchCsv**: () => `Promise`\<`string`\>
Defined in: [Developer/brk/modules/brk-client/index.js:1056](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1056)
Defined in: [Developer/brk/modules/brk-client/index.js:1220](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1220)
Fetch as CSV
@@ -50,11 +50,11 @@ Fetch as CSV
***
### take()
### take
> **take**: (`n`) => [`RangeBuilder`](RangeBuilder.md)\<`T`\>
Defined in: [Developer/brk/modules/brk-client/index.js:1054](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1054)
Defined in: [Developer/brk/modules/brk-client/index.js:1218](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1218)
Take n items after skipped position
@@ -74,6 +74,6 @@ Take n items after skipped position
> **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\>
Defined in: [Developer/brk/modules/brk-client/index.js:1057](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1057)
Defined in: [Developer/brk/modules/brk-client/index.js:1221](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1221)
Thenable