3.8 KiB
brk-client / SeriesDataBase
Interface: SeriesDataBase<T>
Defined in: Developer/brk/modules/brk-client/index.js:1349
Type Parameters
T
T
Properties
data
data:
T[]
Defined in: Developer/brk/modules/brk-client/index.js:1357
The series data
end
end:
number
Defined in: Developer/brk/modules/brk-client/index.js:1355
End index (exclusive)
entries
entries: () => [
number,T][]
Defined in: Developer/brk/modules/brk-client/index.js:1361
Get [index, value] pairs
Returns
[number, T][]
index
index:
Index
Defined in: Developer/brk/modules/brk-client/index.js:1351
The index type used for this query
indexes
indexes: () =>
number[]
Defined in: Developer/brk/modules/brk-client/index.js:1359
Get index numbers
Returns
number[]
isDateBased
isDateBased:
boolean
Defined in: Developer/brk/modules/brk-client/index.js:1358
Whether this series uses a date-based index
keys
keys: () =>
number[]
Defined in: Developer/brk/modules/brk-client/index.js:1360
Get keys as index numbers (alias for indexes)
Returns
number[]
stamp
stamp:
string
Defined in: Developer/brk/modules/brk-client/index.js:1356
ISO 8601 timestamp of when the response was generated
start
start:
number
Defined in: Developer/brk/modules/brk-client/index.js:1354
Start index (inclusive)
toMap
toMap: () =>
Map<number,T>
Defined in: Developer/brk/modules/brk-client/index.js:1362
Convert to Map<index, value>
Returns
Map<number, T>
total
total:
number
Defined in: Developer/brk/modules/brk-client/index.js:1353
Total number of data points
type
type:
string
Defined in: Developer/brk/modules/brk-client/index.js:1352
Value type (e.g. "f32", "u64", "Sats")
version
version:
number
Defined in: Developer/brk/modules/brk-client/index.js:1350
Version of the series data