mirror of
https://github.com/bitcoinresearchkit/brk.git
synced 2026-04-24 14:49:58 -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:672](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L672)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:710](https://github.com/bitcoinresearchkit/brk/blob/afe4123a1799221536f346575595e85e3b7040d4/modules/brk-client/index.js#L710)
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -14,7 +14,7 @@ Defined in: [Developer/brk/modules/brk-client/index.js:672](https://github.com/b
|
||||
|
||||
> **blocksBehind**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:675](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L675)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:713](https://github.com/bitcoinresearchkit/brk/blob/afe4123a1799221536f346575595e85e3b7040d4/modules/brk-client/index.js#L713)
|
||||
|
||||
Number of blocks behind the tip
|
||||
|
||||
@@ -24,7 +24,7 @@ Number of blocks behind the tip
|
||||
|
||||
> **indexedHeight**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:673](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L673)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:711](https://github.com/bitcoinresearchkit/brk/blob/afe4123a1799221536f346575595e85e3b7040d4/modules/brk-client/index.js#L711)
|
||||
|
||||
Height of the last indexed block
|
||||
|
||||
@@ -34,7 +34,7 @@ Height of the last indexed block
|
||||
|
||||
> **lastIndexedAt**: `string`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:676](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L676)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:714](https://github.com/bitcoinresearchkit/brk/blob/afe4123a1799221536f346575595e85e3b7040d4/modules/brk-client/index.js#L714)
|
||||
|
||||
Human-readable timestamp of the last indexed block (ISO 8601)
|
||||
|
||||
@@ -44,7 +44,7 @@ Human-readable timestamp of the last indexed block (ISO 8601)
|
||||
|
||||
> **lastIndexedAtUnix**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:677](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L677)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:715](https://github.com/bitcoinresearchkit/brk/blob/afe4123a1799221536f346575595e85e3b7040d4/modules/brk-client/index.js#L715)
|
||||
|
||||
Unix timestamp of the last indexed block
|
||||
|
||||
@@ -54,6 +54,6 @@ Unix timestamp of the last indexed block
|
||||
|
||||
> **tipHeight**: `number`
|
||||
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:674](https://github.com/bitcoinresearchkit/brk/blob/dc15cceb1ee5fd90210add64f487f8d2140ef45a/modules/brk-client/index.js#L674)
|
||||
Defined in: [Developer/brk/modules/brk-client/index.js:712](https://github.com/bitcoinresearchkit/brk/blob/afe4123a1799221536f346575595e85e3b7040d4/modules/brk-client/index.js#L712)
|
||||
|
||||
Height of the chain tip (from Bitcoin node)
|
||||
|
||||
Reference in New Issue
Block a user