mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-29 09:09: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:542](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L542)
|
|
|
|
## Properties
|
|
|
|
### blocksBehind
|
|
|
|
> **blocksBehind**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:552](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L552)
|
|
|
|
Number of blocks behind the tip
|
|
|
|
***
|
|
|
|
### computedHeight
|
|
|
|
> **computedHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:550](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L550)
|
|
|
|
Height of the last computed block (series)
|
|
|
|
***
|
|
|
|
### indexedHeight
|
|
|
|
> **indexedHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:549](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L549)
|
|
|
|
Height of the last indexed block
|
|
|
|
***
|
|
|
|
### lastIndexedAt
|
|
|
|
> **lastIndexedAt**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:553](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L553)
|
|
|
|
Human-readable timestamp of the last indexed block (ISO 8601)
|
|
|
|
***
|
|
|
|
### lastIndexedAtUnix
|
|
|
|
> **lastIndexedAtUnix**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:554](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L554)
|
|
|
|
Unix timestamp of the last indexed block
|
|
|
|
***
|
|
|
|
### service
|
|
|
|
> **service**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:544](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L544)
|
|
|
|
Service name
|
|
|
|
***
|
|
|
|
### startedAt
|
|
|
|
> **startedAt**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:547](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L547)
|
|
|
|
Server start time (ISO 8601)
|
|
|
|
***
|
|
|
|
### status
|
|
|
|
> **status**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:543](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L543)
|
|
|
|
Health status ("healthy")
|
|
|
|
***
|
|
|
|
### timestamp
|
|
|
|
> **timestamp**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:546](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L546)
|
|
|
|
Current server time (ISO 8601)
|
|
|
|
***
|
|
|
|
### tipHeight
|
|
|
|
> **tipHeight**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:551](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L551)
|
|
|
|
Height of the chain tip (from Bitcoin node)
|
|
|
|
***
|
|
|
|
### uptimeSeconds
|
|
|
|
> **uptimeSeconds**: `number`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:548](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L548)
|
|
|
|
Uptime in seconds
|
|
|
|
***
|
|
|
|
### version
|
|
|
|
> **version**: `string`
|
|
|
|
Defined in: [Developer/brk/modules/brk-client/index.js:545](https://github.com/bitcoinresearchkit/brk/blob/75a97b4da99e60fce9ac789d118004f9b3db3ee5/modules/brk-client/index.js#L545)
|
|
|
|
Server version
|