mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-06-30 06:02:10 -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:1126](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L1126)
|
|
|
|
## Properties
|
|
|
|
### end?
|
|
|
|
> `optional` **end?**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1130](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L1130)
|
|
|
|
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:1132](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L1132)
|
|
|
|
Format of the output
|
|
|
|
***
|
|
|
|
### index
|
|
|
|
> **index**: [`Index`](../type-aliases/Index.md)
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1128](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L1128)
|
|
|
|
Index to query
|
|
|
|
***
|
|
|
|
### limit?
|
|
|
|
> `optional` **limit?**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1131](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L1131)
|
|
|
|
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:1127](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L1127)
|
|
|
|
Requested series
|
|
|
|
***
|
|
|
|
### start?
|
|
|
|
> `optional` **start?**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1129](https://github.com/bitcoinresearchkit/brk/blob/9879a986aa1b6609c39bacbd2ccae5519598e212/modules/brk-client/index.js#L1129)
|
|
|
|
Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `from`, `f`, `s`
|