Files
brk/modules/brk-client/docs/interfaces/MetricLeafWithSchema.md
2026-02-04 22:45:13 +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:401](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L401)
## Properties
### indexes
> **indexes**: [`Index`](../type-aliases/Index.md)[]
Defined in: [Developer/brk/modules/brk-client/index.js:404](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L404)
Available indexes for this metric
***
### kind
> **kind**: `string`
Defined in: [Developer/brk/modules/brk-client/index.js:403](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L403)
The Rust type (e.g., "Sats", "StoredF64")
***
### name
> **name**: `string`
Defined in: [Developer/brk/modules/brk-client/index.js:402](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L402)
The metric name/identifier
***
### type
> **type**: `string`
Defined in: [Developer/brk/modules/brk-client/index.js:405](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L405)
JSON Schema type (e.g., "integer", "number", "string", "boolean", "array", "object")