mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-08-13 02:33:05 -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:615](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L615)
|
|
|
|
## Properties
|
|
|
|
### blocksBehind
|
|
|
|
> **blocksBehind**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:625](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L625)
|
|
|
|
Number of blocks behind the tip
|
|
|
|
***
|
|
|
|
### computedHeight
|
|
|
|
> **computedHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:623](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L623)
|
|
|
|
Height of the last computed block (series)
|
|
|
|
***
|
|
|
|
### indexedHeight
|
|
|
|
> **indexedHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:622](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L622)
|
|
|
|
Height of the last indexed block
|
|
|
|
***
|
|
|
|
### lastIndexedAt
|
|
|
|
> **lastIndexedAt**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:626](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L626)
|
|
|
|
Human-readable timestamp of the last indexed block (ISO 8601)
|
|
|
|
***
|
|
|
|
### lastIndexedAtUnix
|
|
|
|
> **lastIndexedAtUnix**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:627](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L627)
|
|
|
|
Unix timestamp of the last indexed block
|
|
|
|
***
|
|
|
|
### service
|
|
|
|
> **service**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:617](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L617)
|
|
|
|
Service name
|
|
|
|
***
|
|
|
|
### startedAt
|
|
|
|
> **startedAt**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:620](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L620)
|
|
|
|
Server start time (ISO 8601)
|
|
|
|
***
|
|
|
|
### status
|
|
|
|
> **status**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:616](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L616)
|
|
|
|
Health status ("healthy")
|
|
|
|
***
|
|
|
|
### timestamp
|
|
|
|
> **timestamp**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:619](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L619)
|
|
|
|
Current server time (ISO 8601)
|
|
|
|
***
|
|
|
|
### tipHeight
|
|
|
|
> **tipHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:624](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L624)
|
|
|
|
Height of the chain tip (from Bitcoin node)
|
|
|
|
***
|
|
|
|
### uptimeSeconds
|
|
|
|
> **uptimeSeconds**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:621](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L621)
|
|
|
|
Uptime in seconds
|
|
|
|
***
|
|
|
|
### version
|
|
|
|
> **version**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:618](https://github.com/bitcoinresearchkit/brk/blob/cc5b6da341b469859cb457c9c0c93a547eb6ee00/modules/brk-client/index.js#L618)
|
|
|
|
Server version
|