mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-12-05 08:48:14 +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>AccountOffersResponse | ripple-lib</title>
|
||||
<meta name="description" content="Documentation for ripple-lib">
|
||||
<title>AccountOffersResponse | 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="AccountOffersResponse.html">AccountOffersResponse</a>
|
||||
@@ -65,6 +65,13 @@
|
||||
<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>Response expected from an <a href="AccountOffersRequest.html">AccountOffersRequest</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
@@ -86,11 +93,8 @@
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#error" class="tsd-kind-icon">error</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#forwarded" class="tsd-kind-icon">forwarded</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#id" class="tsd-kind-icon">id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#request" class="tsd-kind-icon">request</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite"><a href="AccountOffersResponse.html#result" class="tsd-kind-icon">result</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#status" class="tsd-kind-icon">status</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="AccountOffersResponse.html#type" class="tsd-kind-icon">type</a></li>
|
||||
@@ -110,29 +114,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from BaseResponse.api_version</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="error" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> error</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from BaseResponse.error</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L22">src/models/methods/baseMethod.ts:22</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="error_message" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> error_<wbr>message</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">error_<wbr>message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from BaseResponse.error_message</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L23">src/models/methods/baseMethod.ts:23</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L31">src/models/methods/baseMethod.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -143,7 +125,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from BaseResponse.forwarded</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L21">src/models/methods/baseMethod.ts:21</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L30">src/models/methods/baseMethod.ts:30</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -154,18 +136,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from BaseResponse.id</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L15">src/models/methods/baseMethod.ts:15</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="request" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> request</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">request<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">unknown</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from BaseResponse.request</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L24">src/models/methods/baseMethod.ts:24</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -176,7 +147,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Overrides BaseResponse.result</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/accountOffers.ts#L25">src/models/methods/accountOffers.ts:25</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/accountOffers.ts#L74">src/models/methods/accountOffers.ts:74</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-type-declaration">
|
||||
@@ -184,33 +155,70 @@
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>account<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Unique Address identifying the account that made the offers.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>current_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The ledger index of the current in-progress ledger version, which was
|
||||
used when retrieving this data.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>hash<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The identifying hash of the ledger version that was used when retrieving
|
||||
this data.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> ledger_<wbr>index<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The ledger index of the ledger version that was used when retrieving
|
||||
this data, as requested.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> marker<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Server-defined value indicating the response is paginated. Pass this to
|
||||
the next call to resume where this call left off. Omitted when there are
|
||||
no pages of information after this one.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5><span class="tsd-flag ts-flagOptional">Optional</span> offers<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AccountOffer</span><span class="tsd-signature-symbol">[]</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Array of objects, where each object represents an offer made by this
|
||||
account that is outstanding as of the requested ledger version. If the
|
||||
number of offers is large, only returns up to limit at a time.</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a name="status" class="tsd-anchor"></a>
|
||||
<h3>status</h3>
|
||||
<h3><span class="tsd-flag ts-flagOptional">Optional</span> status</h3>
|
||||
<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">
|
||||
<p>Inherited from BaseResponse.status</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L16">src/models/methods/baseMethod.ts:16</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L25">src/models/methods/baseMethod.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -221,7 +229,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from BaseResponse.type</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L17">src/models/methods/baseMethod.ts:17</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L26">src/models/methods/baseMethod.ts:26</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -232,7 +240,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from BaseResponse.warning</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L19">src/models/methods/baseMethod.ts:19</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L28">src/models/methods/baseMethod.ts:28</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -243,7 +251,7 @@
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from BaseResponse.warnings</p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/ripple/ripple-lib/blob/0c571f2e/src/models/methods/baseMethod.ts#L20">src/models/methods/baseMethod.ts:20</a></li>
|
||||
<li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/615504db/src/models/methods/baseMethod.ts#L29">src/models/methods/baseMethod.ts:29</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
@@ -267,21 +275,12 @@
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="AccountOffersResponse.html#api_version" class="tsd-kind-icon">api_<wbr>version</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="AccountOffersResponse.html#error" class="tsd-kind-icon">error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="AccountOffersResponse.html#error_message" class="tsd-kind-icon">error_<wbr>message</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="AccountOffersResponse.html#forwarded" class="tsd-kind-icon">forwarded</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="AccountOffersResponse.html#id" class="tsd-kind-icon">id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
|
||||
<a href="AccountOffersResponse.html#request" class="tsd-kind-icon">request</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-overwrite">
|
||||
<a href="AccountOffersResponse.html#result" class="tsd-kind-icon">result</a>
|
||||
</li>
|
||||
@@ -316,6 +315,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