mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-08-09 17:13:05 -07:00
nym21
70 lines
2.2 KiB
Markdown
70 lines
2.2 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / SeriesSelection
|
|
|
|
# Interface: SeriesSelection
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1141](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L1141)
|
|
|
|
## Properties
|
|
|
|
### end?
|
|
|
|
> `optional` **end?**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1145](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L1145)
|
|
|
|
Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `to`, `t`, `e`
|
|
|
|
***
|
|
|
|
### format?
|
|
|
|
> `optional` **format?**: [`Format`](../type-aliases/Format.md)
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1147](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L1147)
|
|
|
|
Format of the output
|
|
|
|
***
|
|
|
|
### index
|
|
|
|
> **index**: [`Index`](../type-aliases/Index.md)
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1143](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L1143)
|
|
|
|
Index to query
|
|
|
|
***
|
|
|
|
### limit?
|
|
|
|
> `optional` **limit?**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1146](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L1146)
|
|
|
|
Maximum number of values to return (ignored if `end` is set). Aliases: `count`, `c`, `l`
|
|
|
|
***
|
|
|
|
### series
|
|
|
|
> **series**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1142](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L1142)
|
|
|
|
Requested series
|
|
|
|
***
|
|
|
|
### start?
|
|
|
|
> `optional` **start?**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1144](https://github.com/bitcoinresearchkit/brk/blob/76e08a33afe7d878b09f4359c21ffd6183727e32/modules/brk-client/index.js#L1144)
|
|
|
|
Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `from`, `f`, `s`
|