mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-06-13 16:33:30 -07:00
docs: update generated docs
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
|
||||
# Interface: SyncStatus
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1038](https://github.com/bitcoinresearchkit/brk/blob/07bc2d42b87ba62f766e714bbde023393049d4b7/modules/brk-client/index.js#L1038)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1038](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1038)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:1038](https://github.com/
|
||||
|
||||
> **blocksBehind**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1042](https://github.com/bitcoinresearchkit/brk/blob/07bc2d42b87ba62f766e714bbde023393049d4b7/modules/brk-client/index.js#L1042)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1042](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1042)
|
||||
|
||||
Number of blocks behind the tip
|
||||
|
||||
@@ -24,7 +24,7 @@ Number of blocks behind the tip
|
||||
|
||||
> **computedHeight**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1040](https://github.com/bitcoinresearchkit/brk/blob/07bc2d42b87ba62f766e714bbde023393049d4b7/modules/brk-client/index.js#L1040)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1040](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1040)
|
||||
|
||||
Height of the last computed block (series)
|
||||
|
||||
@@ -34,7 +34,7 @@ Height of the last computed block (series)
|
||||
|
||||
> **indexedHeight**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1039](https://github.com/bitcoinresearchkit/brk/blob/07bc2d42b87ba62f766e714bbde023393049d4b7/modules/brk-client/index.js#L1039)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1039](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1039)
|
||||
|
||||
Height of the last indexed block
|
||||
|
||||
@@ -44,7 +44,7 @@ Height of the last indexed block
|
||||
|
||||
> **lastIndexedAt**: `string`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1043](https://github.com/bitcoinresearchkit/brk/blob/07bc2d42b87ba62f766e714bbde023393049d4b7/modules/brk-client/index.js#L1043)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1043](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1043)
|
||||
|
||||
Human-readable timestamp of the last indexed block (ISO 8601)
|
||||
|
||||
@@ -54,7 +54,7 @@ Human-readable timestamp of the last indexed block (ISO 8601)
|
||||
|
||||
> **lastIndexedAtUnix**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1044](https://github.com/bitcoinresearchkit/brk/blob/07bc2d42b87ba62f766e714bbde023393049d4b7/modules/brk-client/index.js#L1044)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1044](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1044)
|
||||
|
||||
Unix timestamp of the last indexed block
|
||||
|
||||
@@ -64,6 +64,6 @@ Unix timestamp of the last indexed block
|
||||
|
||||
> **tipHeight**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1041](https://github.com/bitcoinresearchkit/brk/blob/07bc2d42b87ba62f766e714bbde023393049d4b7/modules/brk-client/index.js#L1041)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:1041](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1041)
|
||||
|
||||
Height of the chain tip (from Bitcoin node)
|
||||
|
||||
Reference in New Issue
Block a user