mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-26 15:49:58 -07:00
130 lines
3.4 KiB
Markdown
130 lines
3.4 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / Health
|
|
|
|
# Interface: Health
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:529](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L529)
|
|
|
|
## Properties
|
|
|
|
### blocksBehind
|
|
|
|
> **blocksBehind**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:539](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L539)
|
|
|
|
Number of blocks behind the tip
|
|
|
|
***
|
|
|
|
### computedHeight
|
|
|
|
> **computedHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:537](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L537)
|
|
|
|
Height of the last computed block (series)
|
|
|
|
***
|
|
|
|
### indexedHeight
|
|
|
|
> **indexedHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:536](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L536)
|
|
|
|
Height of the last indexed block
|
|
|
|
***
|
|
|
|
### lastIndexedAt
|
|
|
|
> **lastIndexedAt**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:540](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L540)
|
|
|
|
Human-readable timestamp of the last indexed block (ISO 8601)
|
|
|
|
***
|
|
|
|
### lastIndexedAtUnix
|
|
|
|
> **lastIndexedAtUnix**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:541](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L541)
|
|
|
|
Unix timestamp of the last indexed block
|
|
|
|
***
|
|
|
|
### service
|
|
|
|
> **service**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:531](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L531)
|
|
|
|
Service name
|
|
|
|
***
|
|
|
|
### startedAt
|
|
|
|
> **startedAt**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:534](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L534)
|
|
|
|
Server start time (ISO 8601)
|
|
|
|
***
|
|
|
|
### status
|
|
|
|
> **status**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:530](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L530)
|
|
|
|
Health status ("healthy")
|
|
|
|
***
|
|
|
|
### timestamp
|
|
|
|
> **timestamp**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:533](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L533)
|
|
|
|
Current server time (ISO 8601)
|
|
|
|
***
|
|
|
|
### tipHeight
|
|
|
|
> **tipHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:538](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L538)
|
|
|
|
Height of the chain tip (from Bitcoin node)
|
|
|
|
***
|
|
|
|
### uptimeSeconds
|
|
|
|
> **uptimeSeconds**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:535](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L535)
|
|
|
|
Uptime in seconds
|
|
|
|
***
|
|
|
|
### version
|
|
|
|
> **version**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:532](https://github.com/bitcoinresearchkit/brk/blob/acd3d6f42524ece8c85e7b09cc9fdb13b5687b9f/modules/brk-client/index.js#L532)
|
|
|
|
Server version
|