mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 14:49:58 -07:00
docs: update generated docs
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
|
||||
# Interface: MetricSelectionLegacy
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:425](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L425)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:425](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L425)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:425](https://github.com/b
|
||||
|
||||
> `optional` **end**: `number` \| `null`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:429](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L429)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:429](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L429)
|
||||
|
||||
Exclusive ending index, if negative counts from end
|
||||
|
||||
@@ -24,7 +24,7 @@ Exclusive ending index, if negative counts from end
|
||||
|
||||
> `optional` **format**: [`Format`](../type-aliases/Format.md)
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:431](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L431)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:431](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L431)
|
||||
|
||||
Format of the output
|
||||
|
||||
@@ -34,7 +34,7 @@ Format of the output
|
||||
|
||||
> **ids**: `string`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:427](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L427)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:427](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L427)
|
||||
|
||||
***
|
||||
|
||||
@@ -42,7 +42,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:427](https://github.com/b
|
||||
|
||||
> **index**: [`Index`](../type-aliases/Index.md)
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:426](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L426)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:426](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L426)
|
||||
|
||||
***
|
||||
|
||||
@@ -50,7 +50,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:426](https://github.com/b
|
||||
|
||||
> `optional` **limit**: `number` \| `null`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:430](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L430)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:430](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L430)
|
||||
|
||||
Maximum number of values to return (ignored if `end` is set)
|
||||
|
||||
@@ -60,6 +60,6 @@ Maximum number of values to return (ignored if `end` is set)
|
||||
|
||||
> `optional` **start**: `number` \| `null`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:428](https://github.com/bitcoinresearchkit/brk/blob/0433e3b25662fded3395ef89ebe1c68d82b918b1/modules/brk-client/index.js#L428)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:428](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L428)
|
||||
|
||||
Inclusive starting index, if negative counts from end
|
||||
|
||||
Reference in New Issue
Block a user