mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-25 15:19:58 -07:00
122 lines
3.3 KiB
Markdown
122 lines
3.3 KiB
Markdown
[**brk-client**](../README.md)
|
|
|
|
***
|
|
|
|
[brk-client](../globals.md) / Health
|
|
|
|
# Interface: Health
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:501](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L501)
|
|
|
|
## Properties
|
|
|
|
### blocksBehind
|
|
|
|
> **blocksBehind**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:511](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L511)
|
|
|
|
Number of blocks behind the tip
|
|
|
|
***
|
|
|
|
### computedHeight
|
|
|
|
> **computedHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:509](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L509)
|
|
|
|
Height of the last computed block (series)
|
|
|
|
***
|
|
|
|
### indexedHeight
|
|
|
|
> **indexedHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:508](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L508)
|
|
|
|
Height of the last indexed block
|
|
|
|
***
|
|
|
|
### lastIndexedAt
|
|
|
|
> **lastIndexedAt**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:512](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L512)
|
|
|
|
Human-readable timestamp of the last indexed block (ISO 8601)
|
|
|
|
***
|
|
|
|
### lastIndexedAtUnix
|
|
|
|
> **lastIndexedAtUnix**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:513](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L513)
|
|
|
|
Unix timestamp of the last indexed block
|
|
|
|
***
|
|
|
|
### service
|
|
|
|
> **service**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:503](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L503)
|
|
|
|
***
|
|
|
|
### startedAt
|
|
|
|
> **startedAt**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:506](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L506)
|
|
|
|
Server start time (ISO 8601)
|
|
|
|
***
|
|
|
|
### status
|
|
|
|
> **status**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:502](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L502)
|
|
|
|
***
|
|
|
|
### timestamp
|
|
|
|
> **timestamp**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:505](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L505)
|
|
|
|
***
|
|
|
|
### tipHeight
|
|
|
|
> **tipHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:510](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L510)
|
|
|
|
Height of the chain tip (from Bitcoin node)
|
|
|
|
***
|
|
|
|
### uptimeSeconds
|
|
|
|
> **uptimeSeconds**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:507](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L507)
|
|
|
|
Uptime in seconds
|
|
|
|
***
|
|
|
|
### version
|
|
|
|
> **version**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:504](https://github.com/bitcoinresearchkit/brk/blob/83edef4806773ef7225b7c0de863c44bd953169d/modules/brk-client/index.js#L504)
|