mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-25 07:09:59 -07:00
70 lines
1.8 KiB
Markdown
70 lines
1.8 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / PaginatedSeries
|
|
|
|
# Interface: PaginatedSeries
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:558](https://github.com/bitcoinresearchkit/brk/blob/041652d85d1f6ed0371402865bf343ad227ee250/modules/brk-client/index.js#L558)
|
|
|
|
## Properties
|
|
|
|
### currentPage
|
|
|
|
> **currentPage**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:559](https://github.com/bitcoinresearchkit/brk/blob/041652d85d1f6ed0371402865bf343ad227ee250/modules/brk-client/index.js#L559)
|
|
|
|
Current page number (0-indexed)
|
|
|
|
***
|
|
|
|
### hasMore
|
|
|
|
> **hasMore**: `boolean`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:563](https://github.com/bitcoinresearchkit/brk/blob/041652d85d1f6ed0371402865bf343ad227ee250/modules/brk-client/index.js#L563)
|
|
|
|
Whether more pages are available after the current one
|
|
|
|
***
|
|
|
|
### maxPage
|
|
|
|
> **maxPage**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:560](https://github.com/bitcoinresearchkit/brk/blob/041652d85d1f6ed0371402865bf343ad227ee250/modules/brk-client/index.js#L560)
|
|
|
|
Maximum valid page index (0-indexed)
|
|
|
|
***
|
|
|
|
### perPage
|
|
|
|
> **perPage**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:562](https://github.com/bitcoinresearchkit/brk/blob/041652d85d1f6ed0371402865bf343ad227ee250/modules/brk-client/index.js#L562)
|
|
|
|
Results per page
|
|
|
|
***
|
|
|
|
### series
|
|
|
|
> **series**: `string`[]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:564](https://github.com/bitcoinresearchkit/brk/blob/041652d85d1f6ed0371402865bf343ad227ee250/modules/brk-client/index.js#L564)
|
|
|
|
List of series names
|
|
|
|
***
|
|
|
|
### totalCount
|
|
|
|
> **totalCount**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:561](https://github.com/bitcoinresearchkit/brk/blob/041652d85d1f6ed0371402865bf343ad227ee250/modules/brk-client/index.js#L561)
|
|
|
|
Total number of series
|