mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-28 16:15:49 +00:00
build: generates documentation (#1716)
This commit is contained in:
Nathan Nichols
@@ -3,8 +3,8 @@
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>OrderBookStream | ripple-lib</title>
|
||||
<meta name="description" content="Documentation for ripple-lib">
|
||||
<title>OrderBookStream | 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="OrderBookStream.html">OrderBookStream</a>
|
||||
@@ -65,6 +65,16 @@
|
||||
<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>When you subscribe to one or more order books with the <code>books</code> field, you
|
||||
get back any transactions that affect those order books. Has the same format
|
||||
as a <a href="TransactionStream.html">TransactionStream</a> but the transaction can have a <code>owner_funds</code>
|
||||
field.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
@@ -109,7 +119,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">engine_<wbr>result<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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#L98">src/models/methods/subscribe.ts:98</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L289">src/models/methods/subscribe.ts:289</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -119,7 +129,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">engine_<wbr>result_<wbr>code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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#L99">src/models/methods/subscribe.ts:99</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L290">src/models/methods/subscribe.ts:290</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -129,7 +139,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">engine_<wbr>result_<wbr>message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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#L100">src/models/methods/subscribe.ts:100</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L291">src/models/methods/subscribe.ts:291</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -139,7 +149,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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#L101">src/models/methods/subscribe.ts:101</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L292">src/models/methods/subscribe.ts:292</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -149,7 +159,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>hash<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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#L102">src/models/methods/subscribe.ts:102</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L293">src/models/methods/subscribe.ts:293</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -159,7 +169,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">ledger_<wbr>index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</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#L103">src/models/methods/subscribe.ts:103</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L294">src/models/methods/subscribe.ts:294</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -169,7 +179,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">meta<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">default</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#L104">src/models/methods/subscribe.ts:104</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L295">src/models/methods/subscribe.ts:295</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -179,17 +189,17 @@
|
||||
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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#L96">src/models/methods/subscribe.ts:96</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L287">src/models/methods/subscribe.ts:287</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="transaction" class="tsd-anchor"></a>
|
||||
<h3>transaction</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">transaction<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Transaction</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ModifiedOfferCreateTransaction</span></div>
|
||||
<div class="tsd-signature tsd-kind-icon">transaction<span class="tsd-signature-symbol">:</span> <a href="../modules.html#Transaction" class="tsd-signature-type" data-tsd-kind="Type alias">Transaction</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">ModifiedOfferCreateTransaction</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#L105">src/models/methods/subscribe.ts:105</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L296">src/models/methods/subscribe.ts:296</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -200,7 +210,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#L97">src/models/methods/subscribe.ts:97</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L288">src/models/methods/subscribe.ts:288</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -210,7 +220,7 @@
|
||||
<div class="tsd-signature tsd-kind-icon">validated<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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#L106">src/models/methods/subscribe.ts:106</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/subscribe.ts#L297">src/models/methods/subscribe.ts:297</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -283,6 +293,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>
|
||||
|
||||
Reference in New Issue
Block a user