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

16
modules/brk-client/docs/interfaces/SingleItemBuilder.md
View File

@@ -6,7 +6,7 @@
# Interface: SingleItemBuilder\<T\>
Defined in: [Developer/brk/modules/brk-client/index.js:1045](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1045)
Defined in: [Developer/brk/modules/brk-client/index.js:1205](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1205)
## Type Parameters
@@ -16,11 +16,11 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1045](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:1046](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1046)
Defined in: [Developer/brk/modules/brk-client/index.js:1206](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1206)
Fetch the item
@@ -32,15 +32,15 @@ Fetch the item
#### 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:1047](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1047)
Defined in: [Developer/brk/modules/brk-client/index.js:1207](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1207)
Fetch as CSV
@@ -54,6 +54,6 @@ Fetch as CSV
> **then**: [`Thenable`](../type-aliases/Thenable.md)\<`T`\>
Defined in: [Developer/brk/modules/brk-client/index.js:1048](https://github.com/bitcoinresearchkit/brk/blob/4a06caec672337d1974d77b021e6d10711049dbe/modules/brk-client/index.js#L1048)
Defined in: [Developer/brk/modules/brk-client/index.js:1208](https://github.com/bitcoinresearchkit/brk/blob/c4c0004c4a75c182b98b9e69b3c38d3fa6f96f0e/modules/brk-client/index.js#L1208)
Thenable