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-01-27 00:58:45 +01:00
parent ec1f2de5cf
commit aa5c4a8d69
354 changed files with 7275 additions and 5735 deletions
Download Patch File Download Diff File Expand all files Collapse all files

249
modules/brk-client/docs/interfaces/MetricsTree_Price_Oracle.md
View File

@@ -1,249 +0,0 @@
[**brk-client**](../README.md)
***
[brk-client](../globals.md) / MetricsTree\_Price\_Oracle
# Interface: MetricsTree\_Price\_Oracle
Defined in: [Developer/brk/modules/brk-client/index.js:4172](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4172)
## Properties
### closeOhlcCents
> **closeOhlcCents**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<[`OHLCCents`](OHLCCents.md)\>
Defined in: [Developer/brk/modules/brk-client/index.js:4173](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4173)
***
### closeOhlcDollars
> **closeOhlcDollars**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<[`OHLCDollars`](OHLCDollars.md)\>
Defined in: [Developer/brk/modules/brk-client/index.js:4174](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4174)
***
### heightToFirstPairoutputindex
> **heightToFirstPairoutputindex**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4175](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4175)
***
### midOhlcCents
> **midOhlcCents**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<[`OHLCCents`](OHLCCents.md)\>
Defined in: [Developer/brk/modules/brk-client/index.js:4176](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4176)
***
### midOhlcDollars
> **midOhlcDollars**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<[`OHLCDollars`](OHLCDollars.md)\>
Defined in: [Developer/brk/modules/brk-client/index.js:4177](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4177)
***
### ohlcCents
> **ohlcCents**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<[`OHLCCents`](OHLCCents.md)\>
Defined in: [Developer/brk/modules/brk-client/index.js:4178](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4178)
***
### ohlcDollars
> **ohlcDollars**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<[`OHLCDollars`](OHLCDollars.md)\>
Defined in: [Developer/brk/modules/brk-client/index.js:4179](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4179)
***
### output0Value
> **output0Value**: [`MetricPattern33`](../type-aliases/MetricPattern33.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4180](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4180)
***
### output1Value
> **output1Value**: [`MetricPattern33`](../type-aliases/MetricPattern33.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4181](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4181)
***
### pairoutputindexToTxindex
> **pairoutputindexToTxindex**: [`MetricPattern33`](../type-aliases/MetricPattern33.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4182](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4182)
***
### phaseDailyCents
> **phaseDailyCents**: [`PhaseDailyCentsPattern`](PhaseDailyCentsPattern.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4183](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4183)
***
### phaseDailyDollars
> **phaseDailyDollars**: [`PhaseDailyCentsPattern`](PhaseDailyCentsPattern.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4184](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4184)
***
### phaseHistogram
> **phaseHistogram**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<[`OracleBins`](../type-aliases/OracleBins.md)\>
Defined in: [Developer/brk/modules/brk-client/index.js:4185](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4185)
***
### phasePriceCents
> **phasePriceCents**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4186](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4186)
***
### phaseV2DailyCents
> **phaseV2DailyCents**: [`PhaseDailyCentsPattern`](PhaseDailyCentsPattern.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4187](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4187)
***
### phaseV2DailyDollars
> **phaseV2DailyDollars**: [`PhaseDailyCentsPattern`](PhaseDailyCentsPattern.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4188](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4188)
***
### phaseV2Histogram
> **phaseV2Histogram**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<[`OracleBinsV2`](../type-aliases/OracleBinsV2.md)\>
Defined in: [Developer/brk/modules/brk-client/index.js:4189](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4189)
***
### phaseV2PeakDailyCents
> **phaseV2PeakDailyCents**: [`PhaseDailyCentsPattern`](PhaseDailyCentsPattern.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4190](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4190)
***
### phaseV2PeakDailyDollars
> **phaseV2PeakDailyDollars**: [`PhaseDailyCentsPattern`](PhaseDailyCentsPattern.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4191](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4191)
***
### phaseV2PeakPriceCents
> **phaseV2PeakPriceCents**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4192](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4192)
***
### phaseV2PriceCents
> **phaseV2PriceCents**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4193](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4193)
***
### phaseV3DailyCents
> **phaseV3DailyCents**: [`PhaseDailyCentsPattern`](PhaseDailyCentsPattern.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4194](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4194)
***
### phaseV3DailyDollars
> **phaseV3DailyDollars**: [`PhaseDailyCentsPattern`](PhaseDailyCentsPattern.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4195](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4195)
***
### phaseV3Histogram
> **phaseV3Histogram**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<[`OracleBinsV2`](../type-aliases/OracleBinsV2.md)\>
Defined in: [Developer/brk/modules/brk-client/index.js:4196](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4196)
***
### phaseV3PeakDailyCents
> **phaseV3PeakDailyCents**: [`PhaseDailyCentsPattern`](PhaseDailyCentsPattern.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4197](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4197)
***
### phaseV3PeakDailyDollars
> **phaseV3PeakDailyDollars**: [`PhaseDailyCentsPattern`](PhaseDailyCentsPattern.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4198](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4198)
***
### phaseV3PeakPriceCents
> **phaseV3PeakPriceCents**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4199](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4199)
***
### phaseV3PriceCents
> **phaseV3PriceCents**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4200](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4200)
***
### priceCents
> **priceCents**: [`MetricPattern11`](../type-aliases/MetricPattern11.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4201](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4201)
***
### txCount
> **txCount**: [`MetricPattern6`](../type-aliases/MetricPattern6.md)\<`number`\>
Defined in: [Developer/brk/modules/brk-client/index.js:4202](https://github.com/bitcoinresearchkit/brk/blob/616a97d242fb82081d065cfef39ccee8acd45c28/modules/brk-client/index.js#L4202)