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

update reference docs and add readme to homepage (#2112)

Browse Source
This commit is contained in:
jonathanlei
2022-10-13 09:21:28 -07:00
committed by GitHub
parent 9df848fcc6
commit 1ceae703db
214 changed files with 3761 additions and 3651 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/interfaces/LedgerEntry.NegativeUNL.html
View File

@@ -25,7 +25,7 @@ a list of trusted validators currently believed to be offline.</p>
<ul class="tsd-hierarchy">
<li><span class="target">NegativeUNL</span></li></ul></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/NegativeUNL.ts#L14">packages/xrpl/src/models/ledger/NegativeUNL.ts:14</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/NegativeUNL.ts#L14">packages/xrpl/src/models/ledger/NegativeUNL.ts:14</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
@@ -33,10 +33,10 @@ a list of trusted validators currently believed to be offline.</p>
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="LedgerEntry.NegativeUNL.html#DisabledValidators" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>Disabled<wbr/>Validators</span></a>
<div class="tsd-index-list"><a href="LedgerEntry.NegativeUNL.html#DisabledValidators" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="#FF984D" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="12" id="icon-1024-path"></rect><path d="M9.354 16V7.24H12.174C12.99 7.24 13.638 7.476 14.118 7.948C14.606 8.412 14.85 9.036 14.85 9.82C14.85 10.604 14.606 11.232 14.118 11.704C13.638 12.168 12.99 12.4 12.174 12.4H10.434V16H9.354ZM10.434 11.428H12.174C12.646 11.428 13.022 11.284 13.302 10.996C13.59 10.7 13.734 10.308 13.734 9.82C13.734 9.324 13.59 8.932 13.302 8.644C13.022 8.356 12.646 8.212 12.174 8.212H10.434V11.428Z" fill="var(--color-text)" id="icon-1024-text"></path></svg><span>Disabled<wbr/>Validators?</span></a>
<a href="LedgerEntry.NegativeUNL.html#LedgerEntryType" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Ledger<wbr/>Entry<wbr/>Type</span></a>
<a href="LedgerEntry.NegativeUNL.html#ValidatorToDisable" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Validator<wbr/>To<wbr/>Disable</span></a>
<a href="LedgerEntry.NegativeUNL.html#ValidatorToReEnable" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Validator<wbr/>To<wbr/>Re<wbr/>Enable</span></a>
<a href="LedgerEntry.NegativeUNL.html#ValidatorToDisable" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Validator<wbr/>To<wbr/>Disable?</span></a>
<a href="LedgerEntry.NegativeUNL.html#ValidatorToReEnable" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>Validator<wbr/>To<wbr/>Re<wbr/>Enable?</span></a>
<a href="LedgerEntry.NegativeUNL.html#index" class="tsd-index-link tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg><span>index</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
@@ -47,12 +47,12 @@ a list of trusted validators currently believed to be offline.</p>
<div class="tsd-comment tsd-typography"><p>A list of trusted validators that are currently disabled.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/NegativeUNL.ts#L19">packages/xrpl/src/models/ledger/NegativeUNL.ts:19</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/NegativeUNL.ts#L19">packages/xrpl/src/models/ledger/NegativeUNL.ts:19</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="LedgerEntryType" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>Ledger<wbr/>Entry<wbr/>Type</span><a href="#LedgerEntryType" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Ledger<wbr/>Entry<wbr/>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;NegativeUNL&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/NegativeUNL.ts#L15">packages/xrpl/src/models/ledger/NegativeUNL.ts:15</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/NegativeUNL.ts#L15">packages/xrpl/src/models/ledger/NegativeUNL.ts:15</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ValidatorToDisable" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Validator<wbr/>To<wbr/>Disable</span><a href="#ValidatorToDisable" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Validator<wbr/>To<wbr/>Disable<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -60,7 +60,7 @@ a list of trusted validators currently believed to be offline.</p>
the next flag ledger.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/NegativeUNL.ts#L24">packages/xrpl/src/models/ledger/NegativeUNL.ts:24</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/NegativeUNL.ts#L24">packages/xrpl/src/models/ledger/NegativeUNL.ts:24</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="ValidatorToReEnable" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>Validator<wbr/>To<wbr/>Re<wbr/>Enable</span><a href="#ValidatorToReEnable" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">Validator<wbr/>To<wbr/>Re<wbr/>Enable<span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span></div>
@@ -68,13 +68,13 @@ the next flag ledger.</p>
scheduled to be re-enabled in the next flag ledger.</p>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/5fc1c795/packages/xrpl/src/models/ledger/NegativeUNL.ts#L29">packages/xrpl/src/models/ledger/NegativeUNL.ts:29</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/NegativeUNL.ts#L29">packages/xrpl/src/models/ledger/NegativeUNL.ts:29</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a id="index" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>index</span><a href="#index" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">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/5fc1c795/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L2">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/91f4950b/packages/xrpl/src/models/ledger/BaseLedgerEntry.ts#L2">packages/xrpl/src/models/ledger/BaseLedgerEntry.ts:2</a></li></ul></aside></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -101,10 +101,10 @@ scheduled to be re-enabled in the next flag ledger.</p>
<ul>
<li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="LedgerEntry.NegativeUNL.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><rect fill="var(--color-icon-background)" stroke="var(--color-ts-interface)" stroke-width="1.5" x="1" y="1" width="22" height="22" rx="6" id="icon-256-path"></rect><path d="M9.51 16V15.016H11.298V8.224H9.51V7.24H14.19V8.224H12.402V15.016H14.19V16H9.51Z" fill="var(--color-text)" id="icon-256-text"></path></svg><span>NegativeUNL</span></a>
<ul>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.NegativeUNL.html#DisabledValidators" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Disabled<wbr/>Validators</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.NegativeUNL.html#DisabledValidators" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Disabled<wbr/>Validators?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.NegativeUNL.html#LedgerEntryType" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Ledger<wbr/>Entry<wbr/>Type</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.NegativeUNL.html#ValidatorToDisable" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Validator<wbr/>To<wbr/>Disable</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.NegativeUNL.html#ValidatorToReEnable" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Validator<wbr/>To<wbr/>Re<wbr/>Enable</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.NegativeUNL.html#ValidatorToDisable" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Validator<wbr/>To<wbr/>Disable?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="LedgerEntry.NegativeUNL.html#ValidatorToReEnable" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>Validator<wbr/>To<wbr/>Re<wbr/>Enable?</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="LedgerEntry.NegativeUNL.html#index" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-1024-path"></use><use href="#icon-1024-text"></use></svg>index</a></li></ul></li></ul></nav></div></div>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div>