Mirror/brk
1
0
Fork 0
mirror of https://github.com/bitcoinresearchkit/brk.git synced 2026-06-21 03:58:24 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: update generated docs

Browse Source
This commit is contained in:
nym21
2026-05-08 00:35:52 +02:00
parent 6e8be1af22
commit 1643cf86ed
606 changed files with 5386 additions and 4545 deletions
Download Patch File Download Diff File Expand all files Collapse all files
modules/brk-client/docs/interfaces/SyncStatus.md
+7 -7
View File
@@ -6,7 +6,7 @@
# Interface: SyncStatus
Defined in: [Developer/brk/modules/brk-client/index.js:1038](https://github.com/bitcoinresearchkit/brk/blob/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1038)
Defined in: [Developer/brk/modules/brk-client/index.js:1114](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1114)
## 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/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1042)
Defined in: [Developer/brk/modules/brk-client/index.js:1118](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1118)
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/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1040)
Defined in: [Developer/brk/modules/brk-client/index.js:1116](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1116)
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/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1039)
Defined in: [Developer/brk/modules/brk-client/index.js:1115](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1115)
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/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1043)
Defined in: [Developer/brk/modules/brk-client/index.js:1119](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1119)
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/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1044)
Defined in: [Developer/brk/modules/brk-client/index.js:1120](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1120)
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/76869ed2b6aad1e1c3da7aff4c90e9b5788fb606/modules/brk-client/index.js#L1041)
Defined in: [Developer/brk/modules/brk-client/index.js:1117](https://github.com/bitcoinresearchkit/brk/blob/6e8be1af2225890fe02f0a4598e3a4fa8251f535/modules/brk-client/index.js#L1117)
Height of the chain tip (from Bitcoin node)