mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-06-29 21:52:09 -07:00
nym21
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:642](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L642)
|
|
|
|
## Properties
|
|
|
|
### blocksBehind
|
|
|
|
> **blocksBehind**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:652](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L652)
|
|
|
|
Number of blocks behind the tip
|
|
|
|
***
|
|
|
|
### computedHeight
|
|
|
|
> **computedHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:650](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L650)
|
|
|
|
Height of the last computed block (series)
|
|
|
|
***
|
|
|
|
### indexedHeight
|
|
|
|
> **indexedHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:649](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L649)
|
|
|
|
Height of the last indexed block
|
|
|
|
***
|
|
|
|
### lastIndexedAt
|
|
|
|
> **lastIndexedAt**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:653](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L653)
|
|
|
|
Human-readable timestamp of the last indexed block (ISO 8601)
|
|
|
|
***
|
|
|
|
### lastIndexedAtUnix
|
|
|
|
> **lastIndexedAtUnix**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:654](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L654)
|
|
|
|
Unix timestamp of the last indexed block
|
|
|
|
***
|
|
|
|
### service
|
|
|
|
> **service**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:644](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L644)
|
|
|
|
Service name
|
|
|
|
***
|
|
|
|
### startedAt
|
|
|
|
> **startedAt**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:647](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L647)
|
|
|
|
Server start time (ISO 8601)
|
|
|
|
***
|
|
|
|
### status
|
|
|
|
> **status**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:643](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L643)
|
|
|
|
Health status ("healthy")
|
|
|
|
***
|
|
|
|
### timestamp
|
|
|
|
> **timestamp**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:646](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L646)
|
|
|
|
Current server time (ISO 8601)
|
|
|
|
***
|
|
|
|
### tipHeight
|
|
|
|
> **tipHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:651](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L651)
|
|
|
|
Height of the chain tip (from Bitcoin node)
|
|
|
|
***
|
|
|
|
### uptimeSeconds
|
|
|
|
> **uptimeSeconds**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:648](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L648)
|
|
|
|
Uptime in seconds
|
|
|
|
***
|
|
|
|
### version
|
|
|
|
> **version**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:645](https://github.com/bitcoinresearchkit/brk/blob/7a718293c0ddbae305c8352474c81c0e99fe1200/modules/brk-client/index.js#L645)
|
|
|
|
Server version
|