Files
brk/modules/brk-client/docs/interfaces/Health.md
2026-04-03 17:56:12 +02:00

3.4 KiB

brk-client


brk-client / Health

Interface: Health

Defined in: Developer/brk/modules/brk-client/index.js:510

Properties

blocksBehind

blocksBehind: number

Defined in: Developer/brk/modules/brk-client/index.js:520

Number of blocks behind the tip


computedHeight

computedHeight: number

Defined in: Developer/brk/modules/brk-client/index.js:518

Height of the last computed block (series)


indexedHeight

indexedHeight: number

Defined in: Developer/brk/modules/brk-client/index.js:517

Height of the last indexed block


lastIndexedAt

lastIndexedAt: string

Defined in: Developer/brk/modules/brk-client/index.js:521

Human-readable timestamp of the last indexed block (ISO 8601)


lastIndexedAtUnix

lastIndexedAtUnix: number

Defined in: Developer/brk/modules/brk-client/index.js:522

Unix timestamp of the last indexed block


service

service: string

Defined in: Developer/brk/modules/brk-client/index.js:512

Service name


startedAt

startedAt: string

Defined in: Developer/brk/modules/brk-client/index.js:515

Server start time (ISO 8601)


status

status: string

Defined in: Developer/brk/modules/brk-client/index.js:511

Health status ("healthy")


timestamp

timestamp: string

Defined in: Developer/brk/modules/brk-client/index.js:514

Current server time (ISO 8601)


tipHeight

tipHeight: number

Defined in: Developer/brk/modules/brk-client/index.js:519

Height of the chain tip (from Bitcoin node)


uptimeSeconds

uptimeSeconds: number

Defined in: Developer/brk/modules/brk-client/index.js:516

Uptime in seconds


version

version: string

Defined in: Developer/brk/modules/brk-client/index.js:513

Server version