ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-12-06 17:27:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

build: generates documentation (#1716)

Browse Source
This commit is contained in:
Nathan Nichols
2021-10-12 15:06:44 -05:00
committed by GitHub
parent 615504db22
commit 75e56ca927
128 changed files with 26290 additions and 11898 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/interfaces/ConsensusStream.html
View File

@@ -3,8 +3,8 @@
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>ConsensusStream | ripple-lib</title>
<meta name="description" content="Documentation for ripple-lib">
<title>ConsensusStream | xrpl</title>
<meta name="description" content="Documentation for xrpl">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
@@ -23,7 +23,7 @@
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ripple-lib</a>
<a href="../index.html" class="title">xrpl</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
@@ -52,7 +52,7 @@
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">ripple-lib</a>
<a href="../modules.html">xrpl</a>
</li>
<li>
<a href="ConsensusStream.html">ConsensusStream</a>
@@ -65,6 +65,15 @@
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The consensus stream sends consensusPhase messages when the consensus
process changes phase. The message contains the new phase of consensus the
server is in.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
@@ -100,9 +109,15 @@
<div class="tsd-signature tsd-kind-icon">consensus<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;open&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;establish&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;accepted&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L111">src/models/methods/subscribe.ts:111</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L313">src/models/methods/subscribe.ts:313</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The new consensus phase the server is in. Possible values are open,
establish, and accepted.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
<a name="type" class="tsd-anchor"></a>
@@ -111,7 +126,7 @@
<aside class="tsd-sources">
<p>Overrides BaseStream.type</p>
<ul>
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/subscribe.ts#L110">src/models/methods/subscribe.ts:110</a></li>
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L308">src/models/methods/subscribe.ts:308</a></li>
</ul>
</aside>
</section>
@@ -157,6 +172,7 @@
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
</ul>