mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-25 15:19:58 -07:00
50 lines
1.6 KiB
Markdown
50 lines
1.6 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / DataRangeFormat
|
|
|
|
# Interface: DataRangeFormat
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:360](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L360)
|
|
|
|
## Properties
|
|
|
|
### end?
|
|
|
|
> `optional` **end?**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:362](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L362)
|
|
|
|
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:364](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L364)
|
|
|
|
Format of the output
|
|
|
|
***
|
|
|
|
### limit?
|
|
|
|
> `optional` **limit?**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:363](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L363)
|
|
|
|
Maximum number of values to return (ignored if `end` is set). Aliases: `count`, `c`, `l`
|
|
|
|
***
|
|
|
|
### start?
|
|
|
|
> `optional` **start?**: `number` \| `null`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:361](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L361)
|
|
|
|
Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `from`, `f`, `s`
|