Files
brk/modules/brk-client/docs/interfaces/MetricLeafWithSchema.md
2026-01-14 22:46:51 +01:00

50 lines
1.4 KiB
Markdown

[**brk-client**](../README.md)
***
[brk-client](../globals.md) / MetricLeafWithSchema
# 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)
## Properties
### indexes
> **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)
Available indexes for this metric
***
### kind
> **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)
The Rust type (e.g., "Sats", "StoredF64")
***
### name
> **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)
The metric name/identifier
***
### type
> **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)
JSON Schema type (e.g., "integer", "number", "string", "boolean", "array", "object")