ARCHIVE/xahau.js
1
0
Fork 0
mirror of https://github.com/Xahau/xahau.js.git synced 2025-11-13 09:05:49 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gw/add-nft-support
xahau.js/docs/interfaces/LedgerEntry.DirectoryNode.html
Nathan Nichols 14395ab58f build: update package.json version for release (#1755) 
* build: update xrpl.js for release
2021-10-20 11:34:58 -05:00

29 lines
17 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>DirectoryNode | xrpl</title><meta name="description" content="Documentation for xrpl"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><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">xrpl</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">xrpl</a></li><li><a href="../modules/LedgerEntry.html">LedgerEntry</a></li><li><a href="LedgerEntry.DirectoryNode.html">DirectoryNode</a></li></ul><h1>Interface DirectoryNode</h1></div></div></header><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 DirectoryNode object type provides a list of links to other objects in
the ledger&#39;s state tree.</p>
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="tsd-signature-type">BaseLedgerEntry</span><ul class="tsd-hierarchy"><li><span class="target">DirectoryNode</span></li></ul></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#IndexNext" class="tsd-kind-icon">Index<wbr/>Next</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#IndexPrevious" class="tsd-kind-icon">Index<wbr/>Previous</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#Indexes" class="tsd-kind-icon">Indexes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#LedgerEntryType" class="tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#Owner" class="tsd-kind-icon">Owner</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#RootIndex" class="tsd-kind-icon">Root<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#TakerGetsCurrency" class="tsd-kind-icon">Taker<wbr/>Gets<wbr/>Currency</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#TakerGetsIssuer" class="tsd-kind-icon">Taker<wbr/>Gets<wbr/>Issuer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#TakerPaysCurrency" class="tsd-kind-icon">Taker<wbr/>Pays<wbr/>Currency</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#TakerPaysIssuer" class="tsd-kind-icon">Taker<wbr/>Pays<wbr/>Issuer</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntry.DirectoryNode.html#index" class="tsd-kind-icon">index</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Flags" class="tsd-anchor"></a><h3>Flags</h3><div class="tsd-signature tsd-kind-icon">Flags<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/xrplf/xrpl.js/blob/922be621/src/models/ledger/DirectoryNode.ts#L15">src/models/ledger/DirectoryNode.ts:15</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>A bit-map of boolean flags enabled for this directory. Currently, the
protocol defines no flags for DirectoryNode objects.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="IndexNext" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Index<wbr/>Next</h3><div class="tsd-signature tsd-kind-icon">Index<wbr/>Next<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/xrplf/xrpl.js/blob/922be621/src/models/ledger/DirectoryNode.ts#L24">src/models/ledger/DirectoryNode.ts:24</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>If this Directory consists of multiple pages, this ID links to the next
object in the chain, wrapping around at the end.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="IndexPrevious" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Index<wbr/>Previous</h3><div class="tsd-signature tsd-kind-icon">Index<wbr/>Previous<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/xrplf/xrpl.js/blob/922be621/src/models/ledger/DirectoryNode.ts#L29">src/models/ledger/DirectoryNode.ts:29</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>If this Directory consists of multiple pages, this ID links to the
previous object in the chain, wrapping around at the beginning.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Indexes" class="tsd-anchor"></a><h3>Indexes</h3><div class="tsd-signature tsd-kind-icon">Indexes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/ledger/DirectoryNode.ts#L19">src/models/ledger/DirectoryNode.ts:19</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The contents of this Directory: an array of IDs of other objects.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="LedgerEntryType" class="tsd-anchor"></a><h3>Ledger<wbr/>Entry<wbr/>Type</h3><div class="tsd-signature tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;DirectoryNode&quot;</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/ledger/DirectoryNode.ts#L10">src/models/ledger/DirectoryNode.ts:10</a></li></ul></aside></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="Owner" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Owner</h3><div class="tsd-signature tsd-kind-icon">Owner<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/xrplf/xrpl.js/blob/922be621/src/models/ledger/DirectoryNode.ts#L31">src/models/ledger/DirectoryNode.ts:31</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The address of the account that owns the objects in this directory.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="RootIndex" class="tsd-anchor"></a><h3>Root<wbr/>Index</h3><div class="tsd-signature tsd-kind-icon">Root<wbr/>Index<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/xrplf/xrpl.js/blob/922be621/src/models/ledger/DirectoryNode.ts#L17">src/models/ledger/DirectoryNode.ts:17</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The ID of root object for this directory.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="TakerGetsCurrency" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Taker<wbr/>Gets<wbr/>Currency</h3><div class="tsd-signature tsd-kind-icon">Taker<wbr/>Gets<wbr/>Currency<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/xrplf/xrpl.js/blob/922be621/src/models/ledger/DirectoryNode.ts#L43">src/models/ledger/DirectoryNode.ts:43</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The currency code of the TakerGets amount from the offers in this
directory.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="TakerGetsIssuer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Taker<wbr/>Gets<wbr/>Issuer</h3><div class="tsd-signature tsd-kind-icon">Taker<wbr/>Gets<wbr/>Issuer<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/xrplf/xrpl.js/blob/922be621/src/models/ledger/DirectoryNode.ts#L45">src/models/ledger/DirectoryNode.ts:45</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The issuer of the TakerGets amount from the offers in this directory.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="TakerPaysCurrency" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Taker<wbr/>Pays<wbr/>Currency</h3><div class="tsd-signature tsd-kind-icon">Taker<wbr/>Pays<wbr/>Currency<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/xrplf/xrpl.js/blob/922be621/src/models/ledger/DirectoryNode.ts#L36">src/models/ledger/DirectoryNode.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The currency code of the TakerPays amount from the offers in this
directory.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="TakerPaysIssuer" class="tsd-anchor"></a><h3><span class="tsd-flag ts-flagOptional">Optional</span> Taker<wbr/>Pays<wbr/>Issuer</h3><div class="tsd-signature tsd-kind-icon">Taker<wbr/>Pays<wbr/>Issuer<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/xrplf/xrpl.js/blob/922be621/src/models/ledger/DirectoryNode.ts#L38">src/models/ledger/DirectoryNode.ts:38</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>The issuer of the TakerPays amount from the offers in this directory.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a name="index" class="tsd-anchor"></a><h3>index</h3><div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources"><p>Inherited from BaseLedgerEntry.index</p><ul><li>Defined in <a href="https://github.com/xrplf/xrpl.js/blob/922be621/src/models/ledger/BaseLedgerEntry.ts#L2">src/models/ledger/BaseLedgerEntry.ts:2</a></li></ul></aside></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/LedgerEntry.html">Ledger<wbr/>Entry</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="LedgerEntry.DirectoryNode.html" class="tsd-kind-icon">Directory<wbr/>Node</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#Flags" class="tsd-kind-icon">Flags</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#IndexNext" class="tsd-kind-icon">Index<wbr/>Next</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#IndexPrevious" class="tsd-kind-icon">Index<wbr/>Previous</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#Indexes" class="tsd-kind-icon">Indexes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#LedgerEntryType" class="tsd-kind-icon">Ledger<wbr/>Entry<wbr/>Type</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#Owner" class="tsd-kind-icon">Owner</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#RootIndex" class="tsd-kind-icon">Root<wbr/>Index</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#TakerGetsCurrency" class="tsd-kind-icon">Taker<wbr/>Gets<wbr/>Currency</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#TakerGetsIssuer" class="tsd-kind-icon">Taker<wbr/>Gets<wbr/>Issuer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#TakerPaysCurrency" class="tsd-kind-icon">Taker<wbr/>Pays<wbr/>Currency</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.DirectoryNode.html#TakerPaysIssuer" class="tsd-kind-icon">Taker<wbr/>Pays<wbr/>Issuer</a></li><li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntry.DirectoryNode.html#index" class="tsd-kind-icon">index</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><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><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink