mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-08-06 07:33:06 -07:00
nym21
152 lines
3.6 KiB
Markdown
152 lines
3.6 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / SeriesDataBase
|
|
|
|
# Interface: SeriesDataBase\<T\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1659](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1659)
|
|
|
|
## Type Parameters
|
|
|
|
### T
|
|
|
|
`T`
|
|
|
|
## Properties
|
|
|
|
### data
|
|
|
|
> **data**: `T`[]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1666](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1666)
|
|
|
|
The series data
|
|
|
|
***
|
|
|
|
### end
|
|
|
|
> **end**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1664](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1664)
|
|
|
|
End index (exclusive)
|
|
|
|
***
|
|
|
|
### entries
|
|
|
|
> **entries**: () => \[`number`, `T`\][]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1670](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1670)
|
|
|
|
Get [index, value] pairs
|
|
|
|
#### Returns
|
|
|
|
\[`number`, `T`\][]
|
|
|
|
***
|
|
|
|
### index
|
|
|
|
> **index**: [`Index`](../type-aliases/Index.md)
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1661](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1661)
|
|
|
|
The index type used for this query
|
|
|
|
***
|
|
|
|
### indexes
|
|
|
|
> **indexes**: () => `number`[]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1668](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1668)
|
|
|
|
Get index numbers
|
|
|
|
#### Returns
|
|
|
|
`number`[]
|
|
|
|
***
|
|
|
|
### isDateBased
|
|
|
|
> **isDateBased**: `boolean`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1667](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1667)
|
|
|
|
Whether this series uses a date-based index
|
|
|
|
***
|
|
|
|
### keys
|
|
|
|
> **keys**: () => `number`[]
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1669](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1669)
|
|
|
|
Get keys as index numbers (alias for indexes)
|
|
|
|
#### Returns
|
|
|
|
`number`[]
|
|
|
|
***
|
|
|
|
### stamp
|
|
|
|
> **stamp**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1665](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1665)
|
|
|
|
ISO 8601 timestamp of when the response was generated
|
|
|
|
***
|
|
|
|
### start
|
|
|
|
> **start**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1663](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1663)
|
|
|
|
Start index (inclusive)
|
|
|
|
***
|
|
|
|
### toMap
|
|
|
|
> **toMap**: () => `Map`\<`number`, `T`\>
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1671](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1671)
|
|
|
|
Convert to Map<index, value>
|
|
|
|
#### Returns
|
|
|
|
`Map`\<`number`, `T`\>
|
|
|
|
***
|
|
|
|
### type
|
|
|
|
> **type**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1662](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1662)
|
|
|
|
Value type (e.g. "f32", "u64", "Sats")
|
|
|
|
***
|
|
|
|
### version
|
|
|
|
> **version**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:1660](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L1660)
|
|
|
|
Version of the series data
|