Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-04-30 01:20:00 -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

22
modules/brk-client/docs/globals.md
View File

@@ -13,12 +13,14 @@
- [\_0satsPattern](interfaces/0satsPattern.md)
- [\_0satsPattern2](interfaces/0satsPattern2.md)
- [\_0sdUsdPattern](interfaces/0sdUsdPattern.md)
- [\_100btcPattern](interfaces/100btcPattern.md)
- [\_10yPattern](interfaces/10yPattern.md)
- [\_10yTo12yPattern](interfaces/10yTo12yPattern.md)
- [\_1dReturns1mSdPattern](interfaces/1dReturns1mSdPattern.md)
- [\_2015Pattern](interfaces/2015Pattern.md)
- [AaopoolPattern](interfaces/AaopoolPattern.md)
- [ActivePricePattern](interfaces/ActivePricePattern.md)
- [ActivePriceRatioPattern](interfaces/ActivePriceRatioPattern.md)
- [ActiveSupplyPattern](interfaces/ActiveSupplyPattern.md)
- [ActivityPattern2](interfaces/ActivityPattern2.md)
@@ -29,6 +31,7 @@
- [AddressStats](interfaces/AddressStats.md)
- [AddressTxidsParam](interfaces/AddressTxidsParam.md)
- [AddressValidation](interfaces/AddressValidation.md)
- [AllPattern](interfaces/AllPattern.md)
- [BitcoinPattern](interfaces/BitcoinPattern.md)
- [BitcoinPattern2](interfaces/BitcoinPattern2.md)
- [BlockCountParam](interfaces/BlockCountParam.md)
@@ -45,7 +48,7 @@
- [BlockTimestamp](interfaces/BlockTimestamp.md)
- [BlockWeightEntry](interfaces/BlockWeightEntry.md)
- [BrkClientOptions](interfaces/BrkClientOptions.md)
- [ClassAveragePricePattern](interfaces/ClassAveragePricePattern.md)
- [ClassDaysInLossPattern](interfaces/ClassDaysInLossPattern.md)
- [CoinbasePattern](interfaces/CoinbasePattern.md)
- [CoinbasePattern2](interfaces/CoinbasePattern2.md)
- [CostBasisPattern](interfaces/CostBasisPattern.md)
@@ -67,7 +70,6 @@
- [IndexInfo](interfaces/IndexInfo.md)
- [LimitParam](interfaces/LimitParam.md)
- [LoadedAddressData](interfaces/LoadedAddressData.md)
- [LookbackPattern](interfaces/LookbackPattern.md)
- [MempoolBlock](interfaces/MempoolBlock.md)
- [MempoolInfo](interfaces/MempoolInfo.md)
- [MetricCount](interfaces/MetricCount.md)
@@ -99,12 +101,15 @@
- [MetricsTree\_Cointime\_Value](interfaces/MetricsTree_Cointime_Value.md)
- [MetricsTree\_Constants](interfaces/MetricsTree_Constants.md)
- [MetricsTree\_Distribution](interfaces/MetricsTree_Distribution.md)
- [MetricsTree\_Distribution\_AddressActivity](interfaces/MetricsTree_Distribution_AddressActivity.md)
- [MetricsTree\_Distribution\_AddressCohorts](interfaces/MetricsTree_Distribution_AddressCohorts.md)
- [MetricsTree\_Distribution\_AddressCohorts\_AmountRange](interfaces/MetricsTree_Distribution_AddressCohorts_AmountRange.md)
- [MetricsTree\_Distribution\_AddressCohorts\_GeAmount](interfaces/MetricsTree_Distribution_AddressCohorts_GeAmount.md)
- [MetricsTree\_Distribution\_AddressCohorts\_LtAmount](interfaces/MetricsTree_Distribution_AddressCohorts_LtAmount.md)
- [MetricsTree\_Distribution\_AddressesData](interfaces/MetricsTree_Distribution_AddressesData.md)
- [MetricsTree\_Distribution\_AnyAddressIndexes](interfaces/MetricsTree_Distribution_AnyAddressIndexes.md)
- [MetricsTree\_Distribution\_GrowthRate](interfaces/MetricsTree_Distribution_GrowthRate.md)
- [MetricsTree\_Distribution\_NewAddrCount](interfaces/MetricsTree_Distribution_NewAddrCount.md)
- [MetricsTree\_Distribution\_UtxoCohorts](interfaces/MetricsTree_Distribution_UtxoCohorts.md)
- [MetricsTree\_Distribution\_UtxoCohorts\_AgeRange](interfaces/MetricsTree_Distribution_UtxoCohorts_AgeRange.md)
- [MetricsTree\_Distribution\_UtxoCohorts\_All](interfaces/MetricsTree_Distribution_UtxoCohorts_All.md)
@@ -153,13 +158,15 @@
- [MetricsTree\_Market](interfaces/MetricsTree_Market.md)
- [MetricsTree\_Market\_Ath](interfaces/MetricsTree_Market_Ath.md)
- [MetricsTree\_Market\_Dca](interfaces/MetricsTree_Market_Dca.md)
- [MetricsTree\_Market\_Dca\_ClassAveragePrice](interfaces/MetricsTree_Market_Dca_ClassAveragePrice.md)
- [MetricsTree\_Market\_Dca\_ClassDaysInLoss](interfaces/MetricsTree_Market_Dca_ClassDaysInLoss.md)
- [MetricsTree\_Market\_Dca\_ClassDaysInProfit](interfaces/MetricsTree_Market_Dca_ClassDaysInProfit.md)
- [MetricsTree\_Market\_Dca\_ClassMaxDrawdown](interfaces/MetricsTree_Market_Dca_ClassMaxDrawdown.md)
- [MetricsTree\_Market\_Dca\_ClassMaxReturn](interfaces/MetricsTree_Market_Dca_ClassMaxReturn.md)
- [MetricsTree\_Market\_Dca\_ClassReturns](interfaces/MetricsTree_Market_Dca_ClassReturns.md)
- [MetricsTree\_Market\_Dca\_ClassStack](interfaces/MetricsTree_Market_Dca_ClassStack.md)
- [MetricsTree\_Market\_Dca\_PeriodAveragePrice](interfaces/MetricsTree_Market_Dca_PeriodAveragePrice.md)
- [MetricsTree\_Market\_Indicators](interfaces/MetricsTree_Market_Indicators.md)
- [MetricsTree\_Market\_Lookback](interfaces/MetricsTree_Market_Lookback.md)
- [MetricsTree\_Market\_MovingAverage](interfaces/MetricsTree_Market_MovingAverage.md)
- [MetricsTree\_Market\_Range](interfaces/MetricsTree_Market_Range.md)
- [MetricsTree\_Market\_Returns](interfaces/MetricsTree_Market_Returns.md)
@@ -174,7 +181,6 @@
- [MetricsTree\_Price](interfaces/MetricsTree_Price.md)
- [MetricsTree\_Price\_Cents](interfaces/MetricsTree_Price_Cents.md)
- [MetricsTree\_Price\_Cents\_Split](interfaces/MetricsTree_Price_Cents_Split.md)
- [MetricsTree\_Price\_Oracle](interfaces/MetricsTree_Price_Oracle.md)
- [MetricsTree\_Price\_Sats](interfaces/MetricsTree_Price_Sats.md)
- [MetricsTree\_Scripts](interfaces/MetricsTree_Scripts.md)
- [MetricsTree\_Scripts\_Count](interfaces/MetricsTree_Scripts_Count.md)
@@ -198,10 +204,9 @@
- [PaginatedMetrics](interfaces/PaginatedMetrics.md)
- [Pagination](interfaces/Pagination.md)
- [PercentilesPattern](interfaces/PercentilesPattern.md)
- [PeriodAveragePricePattern](interfaces/PeriodAveragePricePattern.md)
- [PeriodCagrPattern](interfaces/PeriodCagrPattern.md)
- [PeriodDaysInLossPattern](interfaces/PeriodDaysInLossPattern.md)
- [PeriodLumpSumStackPattern](interfaces/PeriodLumpSumStackPattern.md)
- [PhaseDailyCentsPattern](interfaces/PhaseDailyCentsPattern.md)
- [PoolBlockCounts](interfaces/PoolBlockCounts.md)
- [PoolBlockShares](interfaces/PoolBlockShares.md)
- [PoolDetail](interfaces/PoolDetail.md)
@@ -302,7 +307,6 @@
- [MetricPattern30](type-aliases/MetricPattern30.md)
- [MetricPattern31](type-aliases/MetricPattern31.md)
- [MetricPattern32](type-aliases/MetricPattern32.md)
- [MetricPattern33](type-aliases/MetricPattern33.md)
- [MetricPattern4](type-aliases/MetricPattern4.md)
- [MetricPattern5](type-aliases/MetricPattern5.md)
- [MetricPattern6](type-aliases/MetricPattern6.md)
@@ -313,8 +317,6 @@
- [MonthIndex](type-aliases/MonthIndex.md)
- [Open](type-aliases/Open.md)
- [OpReturnIndex](type-aliases/OpReturnIndex.md)
- [OracleBins](type-aliases/OracleBins.md)
- [OracleBinsV2](type-aliases/OracleBinsV2.md)
- [OutPoint](type-aliases/OutPoint.md)
- [OutputType](type-aliases/OutputType.md)
- [P2AAddressIndex](type-aliases/P2AAddressIndex.md)
@@ -334,11 +336,11 @@
- [P2WPKHBytes](type-aliases/P2WPKHBytes.md)
- [P2WSHAddressIndex](type-aliases/P2WSHAddressIndex.md)
- [P2WSHBytes](type-aliases/P2WSHBytes.md)
- [PairOutputIndex](type-aliases/PairOutputIndex.md)
- [PoolSlug](type-aliases/PoolSlug.md)
- [QuarterIndex](type-aliases/QuarterIndex.md)
- [RawLockTime](type-aliases/RawLockTime.md)
- [Sats](type-aliases/Sats.md)
- [SatsFract](type-aliases/SatsFract.md)
- [SemesterIndex](type-aliases/SemesterIndex.md)
- [StoredBool](type-aliases/StoredBool.md)
- [StoredF32](type-aliases/StoredF32.md)