Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-04-25 07:09:59 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update generated docs

Browse Source
This commit is contained in:
nym21
2026-01-17 22:48:00 +01:00
parent 2e1037ff36
commit ac30f0e512
358 changed files with 2491 additions and 2035 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
modules/brk-client/docs/interfaces/MetricLeafWithSchema.md
View File

@@ -6,7 +6,7 @@
# Interface: MetricLeafWithSchema
Defined in: [Developer/brk/modules/brk-client/index.js:382](https://github.com/bitcoinresearchkit/brk/blob/467dfcc4b801a25e7d5f0ec4af8dddfffc3861d4/modules/brk-client/index.js#L382)
Defined in: [Developer/brk/modules/brk-client/index.js:382](https://github.com/bitcoinresearchkit/brk/blob/2e1037ff3648b9362cc223c71160f3d69c7730ad/modules/brk-client/index.js#L382)
## Properties
@@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:382](https://github.com/b
> **indexes**: [`Index`](../type-aliases/Index.md)[]
Defined in: [Developer/brk/modules/brk-client/index.js:385](https://github.com/bitcoinresearchkit/brk/blob/467dfcc4b801a25e7d5f0ec4af8dddfffc3861d4/modules/brk-client/index.js#L385)
Defined in: [Developer/brk/modules/brk-client/index.js:385](https://github.com/bitcoinresearchkit/brk/blob/2e1037ff3648b9362cc223c71160f3d69c7730ad/modules/brk-client/index.js#L385)
Available indexes for this metric
@@ -24,7 +24,7 @@ Available indexes for this metric
> **kind**: `string`
Defined in: [Developer/brk/modules/brk-client/index.js:384](https://github.com/bitcoinresearchkit/brk/blob/467dfcc4b801a25e7d5f0ec4af8dddfffc3861d4/modules/brk-client/index.js#L384)
Defined in: [Developer/brk/modules/brk-client/index.js:384](https://github.com/bitcoinresearchkit/brk/blob/2e1037ff3648b9362cc223c71160f3d69c7730ad/modules/brk-client/index.js#L384)
The Rust type (e.g., "Sats", "StoredF64")
@@ -34,7 +34,7 @@ The Rust type (e.g., "Sats", "StoredF64")
> **name**: `string`
Defined in: [Developer/brk/modules/brk-client/index.js:383](https://github.com/bitcoinresearchkit/brk/blob/467dfcc4b801a25e7d5f0ec4af8dddfffc3861d4/modules/brk-client/index.js#L383)
Defined in: [Developer/brk/modules/brk-client/index.js:383](https://github.com/bitcoinresearchkit/brk/blob/2e1037ff3648b9362cc223c71160f3d69c7730ad/modules/brk-client/index.js#L383)
The metric name/identifier
@@ -44,6 +44,6 @@ The metric name/identifier
> **type**: `string`
Defined in: [Developer/brk/modules/brk-client/index.js:386](https://github.com/bitcoinresearchkit/brk/blob/467dfcc4b801a25e7d5f0ec4af8dddfffc3861d4/modules/brk-client/index.js#L386)
Defined in: [Developer/brk/modules/brk-client/index.js:386](https://github.com/bitcoinresearchkit/brk/blob/2e1037ff3648b9362cc223c71160f3d69c7730ad/modules/brk-client/index.js#L386)
JSON Schema type (e.g., "integer", "number", "string", "boolean", "array", "object")