mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 14:49:58 -07:00
162 lines
3.8 KiB
Markdown
162 lines
3.8 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / SeriesDataBase
|
|
|
|
# Interface: SeriesDataBase\<T\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1325](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1325)
|
|
|
|
## Type Parameters
|
|
|
|
### T
|
|
|
|
`T`
|
|
|
|
## Properties
|
|
|
|
### data
|
|
|
|
> **data**: `T`[]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1333](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1333)
|
|
|
|
The series data
|
|
|
|
***
|
|
|
|
### end
|
|
|
|
> **end**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1331](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1331)
|
|
|
|
End index (exclusive)
|
|
|
|
***
|
|
|
|
### entries
|
|
|
|
> **entries**: () => \[`number`, `T`\][]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1337](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1337)
|
|
|
|
Get [index, value] pairs
|
|
|
|
#### Returns
|
|
|
|
\[`number`, `T`\][]
|
|
|
|
***
|
|
|
|
### index
|
|
|
|
> **index**: [`Index`](../type-aliases/Index.md)
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1327](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1327)
|
|
|
|
The index type used for this query
|
|
|
|
***
|
|
|
|
### indexes
|
|
|
|
> **indexes**: () => `number`[]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1335](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1335)
|
|
|
|
Get index numbers
|
|
|
|
#### Returns
|
|
|
|
`number`[]
|
|
|
|
***
|
|
|
|
### isDateBased
|
|
|
|
> **isDateBased**: `boolean`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1334](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1334)
|
|
|
|
Whether this series uses a date-based index
|
|
|
|
***
|
|
|
|
### keys
|
|
|
|
> **keys**: () => `number`[]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1336](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1336)
|
|
|
|
Get keys as index numbers (alias for indexes)
|
|
|
|
#### Returns
|
|
|
|
`number`[]
|
|
|
|
***
|
|
|
|
### stamp
|
|
|
|
> **stamp**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1332](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1332)
|
|
|
|
ISO 8601 timestamp of when the response was generated
|
|
|
|
***
|
|
|
|
### start
|
|
|
|
> **start**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1330](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1330)
|
|
|
|
Start index (inclusive)
|
|
|
|
***
|
|
|
|
### toMap
|
|
|
|
> **toMap**: () => `Map`\<`number`, `T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1338](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1338)
|
|
|
|
Convert to Map<index, value>
|
|
|
|
#### Returns
|
|
|
|
`Map`\<`number`, `T`\>
|
|
|
|
***
|
|
|
|
### total
|
|
|
|
> **total**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1329](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1329)
|
|
|
|
Total number of data points
|
|
|
|
***
|
|
|
|
### type
|
|
|
|
> **type**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1328](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1328)
|
|
|
|
Value type (e.g. "f32", "u64", "Sats")
|
|
|
|
***
|
|
|
|
### version
|
|
|
|
> **version**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1326](https://github.com/bitcoinresearchkit/brk/blob/8bc993ecebee68170d873d232b25f3b1f2d71378/modules/brk-client/index.js#L1326)
|
|
|
|
Version of the series data
|