mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-25 07:09:59 -07:00
docs: update generated docs
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
|
||||
# Interface: PaginatedMetrics
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:541](https://github.com/bitcoinresearchkit/brk/blob/ba60b7e4f64e81cffbd4781566a0df0728014881/modules/brk-client/index.js#L541)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:541](https://github.com/bitcoinresearchkit/brk/blob/dfcb04484b3a4203772bb13ff5945fb24d8bbd9f/modules/brk-client/index.js#L541)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:541](https://github.com/b
|
||||
|
||||
> **currentPage**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:542](https://github.com/bitcoinresearchkit/brk/blob/ba60b7e4f64e81cffbd4781566a0df0728014881/modules/brk-client/index.js#L542)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:542](https://github.com/bitcoinresearchkit/brk/blob/dfcb04484b3a4203772bb13ff5945fb24d8bbd9f/modules/brk-client/index.js#L542)
|
||||
|
||||
Current page number (0-indexed)
|
||||
|
||||
@@ -24,7 +24,7 @@ Current page number (0-indexed)
|
||||
|
||||
> **maxPage**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:543](https://github.com/bitcoinresearchkit/brk/blob/ba60b7e4f64e81cffbd4781566a0df0728014881/modules/brk-client/index.js#L543)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:543](https://github.com/bitcoinresearchkit/brk/blob/dfcb04484b3a4203772bb13ff5945fb24d8bbd9f/modules/brk-client/index.js#L543)
|
||||
|
||||
Maximum valid page index (0-indexed)
|
||||
|
||||
@@ -34,6 +34,6 @@ Maximum valid page index (0-indexed)
|
||||
|
||||
> **metrics**: `string`[]
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:544](https://github.com/bitcoinresearchkit/brk/blob/ba60b7e4f64e81cffbd4781566a0df0728014881/modules/brk-client/index.js#L544)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:544](https://github.com/bitcoinresearchkit/brk/blob/dfcb04484b3a4203772bb13ff5945fb24d8bbd9f/modules/brk-client/index.js#L544)
|
||||
|
||||
List of metric names (max 1000 per page)
|
||||
|
||||
Reference in New Issue
Block a user