Release xrpl.js 2.11.0 (#2591)

Update HISTORY.md + Run docgen
This commit is contained in:
Jackson Mills
2023-11-30 13:27:12 -08:00
committed by GitHub
parent 98abafbf12
commit 99dd0eb44c
341 changed files with 6499 additions and 2655 deletions

View File

@@ -31,7 +31,7 @@ throwing, and allowing the user to handle in the catch block of a promise.</p>
<ul class="tsd-hierarchy">
<li><span class="target">ErrorResponse</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L49">packages/xrpl/src/models/methods/baseMethod.ts:49</a></li></ul></aside>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/baseMethod.ts#L49">packages/xrpl/src/models/methods/baseMethod.ts:49</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">
@@ -54,42 +54,42 @@ throwing, and allowing the user to handle in the catch block of a promise.</p>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>api_<wbr/>version</span><a href="#api_version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><g stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round" id="icon-anchor"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></g></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">api_<wbr/>version</span><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/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L57">packages/xrpl/src/models/methods/baseMethod.ts:57</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/baseMethod.ts#L57">packages/xrpl/src/models/methods/baseMethod.ts:57</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="error" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>error</span><a href="#error" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">error</span><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/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L53">packages/xrpl/src/models/methods/baseMethod.ts:53</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/baseMethod.ts#L53">packages/xrpl/src/models/methods/baseMethod.ts:53</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="error_code" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>error_<wbr/>code</span><a href="#error_code" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">error_<wbr/>code</span><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/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L54">packages/xrpl/src/models/methods/baseMethod.ts:54</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/baseMethod.ts#L54">packages/xrpl/src/models/methods/baseMethod.ts:54</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="error_message" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagOptional">Optional</code> <span>error_<wbr/>message</span><a href="#error_message" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">error_<wbr/>message</span><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/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L55">packages/xrpl/src/models/methods/baseMethod.ts:55</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/baseMethod.ts#L55">packages/xrpl/src/models/methods/baseMethod.ts:55</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="id" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L50">packages/xrpl/src/models/methods/baseMethod.ts:50</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/baseMethod.ts#L50">packages/xrpl/src/models/methods/baseMethod.ts:50</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="request" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>request</span><a href="#request" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">request</span><span class="tsd-signature-symbol">:</span> <a href="../types/Request.html" class="tsd-signature-type tsd-kind-type-alias">Request</a></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L56">packages/xrpl/src/models/methods/baseMethod.ts:56</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/baseMethod.ts#L56">packages/xrpl/src/models/methods/baseMethod.ts:56</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="status" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>status</span><a href="#status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">status</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;error&quot;</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L51">packages/xrpl/src/models/methods/baseMethod.ts:51</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/baseMethod.ts#L51">packages/xrpl/src/models/methods/baseMethod.ts:51</a></li></ul></aside></section>
<section class="tsd-panel tsd-member"><a id="type" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">type</span><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/8b781479/packages/xrpl/src/models/methods/baseMethod.ts#L52">packages/xrpl/src/models/methods/baseMethod.ts:52</a></li></ul></aside></section></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/98abafbf1/packages/xrpl/src/models/methods/baseMethod.ts#L52">packages/xrpl/src/models/methods/baseMethod.ts:52</a></li></ul></aside></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
@@ -204,6 +204,8 @@ throwing, and allowing the user to handle in the catch block of a promise.</p>
<li><a href="ClientOptions.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Client<wbr/>Options</span></a></li>
<li><a href="ConsensusStream.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Consensus<wbr/>Stream</span></a></li>
<li><a href="CreatedNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Created<wbr/>Node</span></a></li>
<li><a href="DIDDelete.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>DIDDelete</span></a></li>
<li><a href="DIDSet.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>DIDSet</span></a></li>
<li><a href="DeletedNode.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Deleted<wbr/>Node</span></a></li>
<li><a href="DepositAuthorizedRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Deposit<wbr/>Authorized<wbr/>Request</span></a></li>
<li><a href="DepositAuthorizedResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Deposit<wbr/>Authorized<wbr/>Response</span></a></li>
@@ -288,6 +290,8 @@ throwing, and allowing the user to handle in the catch block of a promise.</p>
<li><a href="RipplePathFindPathOption.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ripple<wbr/>Path<wbr/>Find<wbr/>Path<wbr/>Option</span></a></li>
<li><a href="RipplePathFindRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ripple<wbr/>Path<wbr/>Find<wbr/>Request</span></a></li>
<li><a href="RipplePathFindResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Ripple<wbr/>Path<wbr/>Find<wbr/>Response</span></a></li>
<li><a href="ServerDefinitionsRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Definitions<wbr/>Request</span></a></li>
<li><a href="ServerDefinitionsResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Definitions<wbr/>Response</span></a></li>
<li><a href="ServerInfoRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Info<wbr/>Request</span></a></li>
<li><a href="ServerInfoResponse.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>Info<wbr/>Response</span></a></li>
<li><a href="ServerStateRequest.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-256"></use></svg><span>Server<wbr/>State<wbr/>Request</span></a></li>