update docs for v1.31

This commit is contained in:
Freddie Wang 2021-04-10 11:05:16 +08:00
parent 06aadd6e05
commit abe0cd58c1
4 changed files with 100 additions and 16 deletions

File diff suppressed because one or more lines are too long

View File

@ -179,7 +179,7 @@
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="range" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> range</h3>
<div class="tsd-signature tsd-kind-icon">range<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">]</span></div>
<div class="tsd-signature tsd-kind-icon">range<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:103</li>

View File

@ -115,7 +115,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1105</li>
<li>Defined in asphyxia-core.d.ts:1123</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -138,7 +138,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1106</li>
<li>Defined in asphyxia-core.d.ts:1124</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -168,7 +168,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1062</li>
<li>Defined in asphyxia-core.d.ts:1080</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -191,7 +191,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1063</li>
<li>Defined in asphyxia-core.d.ts:1081</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -221,7 +221,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1059</li>
<li>Defined in asphyxia-core.d.ts:1077</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -244,7 +244,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1060</li>
<li>Defined in asphyxia-core.d.ts:1078</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -274,7 +274,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1065</li>
<li>Defined in asphyxia-core.d.ts:1083</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -297,7 +297,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1066</li>
<li>Defined in asphyxia-core.d.ts:1084</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -327,7 +327,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1068</li>
<li>Defined in asphyxia-core.d.ts:1086</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -350,7 +350,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1069</li>
<li>Defined in asphyxia-core.d.ts:1087</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -380,7 +380,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1071</li>
<li>Defined in asphyxia-core.d.ts:1089</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -406,7 +406,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1079</li>
<li>Defined in asphyxia-core.d.ts:1097</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -439,7 +439,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1087</li>
<li>Defined in asphyxia-core.d.ts:1105</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
@ -465,7 +465,7 @@
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:1096</li>
<li>Defined in asphyxia-core.d.ts:1114</li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>

View File

@ -80,6 +80,8 @@
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="u.html#card2nfc" class="tsd-kind-icon">Card2NFC</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="u.html#decodestring" class="tsd-kind-icon">Decode<wbr>String</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="u.html#encodestring" class="tsd-kind-icon">Encode<wbr>String</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="u.html#getconfig" class="tsd-kind-icon">Get<wbr>Config</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="u.html#nfc2card" class="tsd-kind-icon">NFC2<wbr>Card</a></li>
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="u.html#parsexml" class="tsd-kind-icon">parseXML</a></li>
@ -123,6 +125,82 @@
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="decodestring" class="tsd-anchor"></a>
<h3>Decode<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">Decode<wbr>String<span class="tsd-signature-symbol">(</span>buffer<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span>, encoding<span class="tsd-signature-symbol">: </span><a href="../index.html#kencoding" class="tsd-signature-type">KEncoding</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:964</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Decode a string from a specified encoding</p>
</div>
<p>returns a string</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>buffer: <span class="tsd-signature-type">Buffer</span></h5>
<div class="tsd-comment tsd-typography">
<p>binary data to decode</p>
</div>
</li>
<li>
<h5>encoding: <a href="../index.html#kencoding" class="tsd-signature-type">KEncoding</a></h5>
<div class="tsd-comment tsd-typography">
<p>see <a href="../index.html#kencoding">KEncoding</a></p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="encodestring" class="tsd-anchor"></a>
<h3>Encode<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
<li class="tsd-signature tsd-kind-icon">Encode<wbr>String<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, encoding<span class="tsd-signature-symbol">: </span><a href="../index.html#kencoding" class="tsd-signature-type">KEncoding</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Buffer</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in asphyxia-core.d.ts:955</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Encode a string into a specified encoding</p>
</div>
<p>returns a binary buffer</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>str: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>string to encode</p>
</div>
</li>
<li>
<h5>encoding: <a href="../index.html#kencoding" class="tsd-signature-type">KEncoding</a></h5>
<div class="tsd-comment tsd-typography">
<p>see <a href="../index.html#kencoding">KEncoding</a></p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
<a name="getconfig" class="tsd-anchor"></a>
<h3>Get<wbr>Config</h3>
@ -283,6 +361,12 @@
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="u.html#card2nfc" class="tsd-kind-icon">Card2NFC</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="u.html#decodestring" class="tsd-kind-icon">Decode<wbr>String</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="u.html#encodestring" class="tsd-kind-icon">Encode<wbr>String</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-namespace">
<a href="u.html#getconfig" class="tsd-kind-icon">Get<wbr>Config</a>
</li>