mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 14:49:58 -07:00
70 lines
2.0 KiB
Markdown
70 lines
2.0 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / MetricSelection
|
|
|
|
# Interface: MetricSelection
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:414](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L414)
|
|
|
|
## Properties
|
|
|
|
### end?
|
|
|
|
> `optional` **end**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:418](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L418)
|
|
|
|
Exclusive ending index, if negative counts from end
|
|
|
|
***
|
|
|
|
### format?
|
|
|
|
> `optional` **format**: [`Format`](../type-aliases/Format.md)
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:420](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L420)
|
|
|
|
Format of the output
|
|
|
|
***
|
|
|
|
### index
|
|
|
|
> **index**: [`Index`](../type-aliases/Index.md)
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:416](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L416)
|
|
|
|
Index to query
|
|
|
|
***
|
|
|
|
### limit?
|
|
|
|
> `optional` **limit**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:419](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L419)
|
|
|
|
Maximum number of values to return (ignored if `end` is set)
|
|
|
|
***
|
|
|
|
### metrics
|
|
|
|
> **metrics**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:415](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L415)
|
|
|
|
Requested metrics
|
|
|
|
***
|
|
|
|
### start?
|
|
|
|
> `optional` **start**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:417](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L417)
|
|
|
|
Inclusive starting index, if negative counts from end
|