框架核心模块注释文档补全

This commit is contained in:
dgflash
2022-09-02 14:54:04 +08:00
parent a68a8ff5ae
commit a7eeba8659
96 changed files with 5644 additions and 1630 deletions

View File

@@ -60,18 +60,22 @@
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="format.format-1">format<span class="tsd-signature-symbol">(</span>date<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Date</span>, fmt<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#format.format-1" 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></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>yyyy-MM-dd hh:mm:ss S</p>
<div class="tsd-comment tsd-typography"><p>时间格式化</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>date: <span class="tsd-signature-type">Date</span></h5></li>
<h5>date: <span class="tsd-signature-type">Date</span></h5>
<div class="tsd-comment tsd-typography"><p>时间对象</p>
</div></li>
<li>
<h5>fmt: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h5>fmt: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>格式化字符(yyyy-MM-dd hh:mm:ss S)</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in assets/core/utils/StringUtil.ts:48</li></ul></aside></li></ul></section>
<li>Defined in assets/core/utils/StringUtil.ts:69</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="guid" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>guid</span><a href="#guid" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -87,63 +91,86 @@
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="numberToTenThousand.numberToTenThousand-1">number<wbr/>To<wbr/>Ten<wbr/>Thousand<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, fixed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#numberToTenThousand.numberToTenThousand-1" 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></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>12345 = 1.23万</p>
<div class="tsd-comment tsd-typography"><p>转中文单位计数</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-7">12345</span><span class="hl-1"> = 1.23</span><span class="hl-0"></span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>value: <span class="tsd-signature-type">number</span></h5></li>
<h5>value: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>数字</p>
</div></li>
<li>
<h5>fixed: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2</span></h5></li></ul></div>
<h5>fixed: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2</span></h5>
<div class="tsd-comment tsd-typography"><p>保留小数位数</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in assets/core/utils/StringUtil.ts:35</li></ul></aside></li></ul></section>
<li>Defined in assets/core/utils/StringUtil.ts:52</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="numberToThousand" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>number<wbr/>To<wbr/>Thousand</span><a href="#numberToThousand" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="numberToThousand.numberToThousand-1">number<wbr/>To<wbr/>Thousand<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, fixed<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#numberToThousand.numberToThousand-1" 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></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>12345 = 12.35K</p>
<div class="tsd-comment tsd-typography"><p>转英文单位计数</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-7">12345</span><span class="hl-1"> = 12.35</span><span class="hl-8">K</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>value: <span class="tsd-signature-type">number</span></h5></li>
<h5>value: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>数字</p>
</div></li>
<li>
<h5>fixed: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2</span></h5></li></ul></div>
<h5>fixed: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2</span></h5>
<div class="tsd-comment tsd-typography"><p>保留小数位数</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in assets/core/utils/StringUtil.ts:21</li></ul></aside></li></ul></section>
<li>Defined in assets/core/utils/StringUtil.ts:32</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="numberTotPermil" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>number<wbr/>Tot<wbr/>Permil</span><a href="#numberTotPermil" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="numberTotPermil.numberTotPermil-1">number<wbr/>Tot<wbr/>Permil<span class="tsd-signature-symbol">(</span>num<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#numberTotPermil.numberTotPermil-1" 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></li>
<li class="tsd-signature tsd-anchor-link" id="numberTotPermil.numberTotPermil-1">number<wbr/>Tot<wbr/>Permil<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#numberTotPermil.numberTotPermil-1" 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></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>123456789 = 123,456,789</p>
<div class="tsd-comment tsd-typography"><p>转美式计数字符串</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-7">123456789</span><span class="hl-1"> = </span><span class="hl-7">123</span><span class="hl-1">,</span><span class="hl-7">456</span><span class="hl-1">,</span><span class="hl-7">789</span>
</code></pre>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>num: <span class="tsd-signature-type">number</span></h5></li></ul></div>
<h5>value: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>数字</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in assets/core/utils/StringUtil.ts:16</li></ul></aside></li></ul></section>
<li>Defined in assets/core/utils/StringUtil.ts:21</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stringLen" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>string<wbr/>Len</span><a href="#stringLen" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="stringLen.stringLen-1">string<wbr/>Len<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><a href="#stringLen.stringLen-1" 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></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>计算字符串长度,中文算两个字节</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h5>str: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>字符串</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in assets/core/utils/StringUtil.ts:119</li></ul></aside></li></ul></section>
<li>Defined in assets/core/utils/StringUtil.ts:160</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stringToArray1" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>string<wbr/>To<wbr/>Array1</span><a href="#stringToArray1" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -155,10 +182,12 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h5>str: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>字符串</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in assets/core/utils/StringUtil.ts:70</li></ul></aside></li></ul></section>
<li>Defined in assets/core/utils/StringUtil.ts:94</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stringToArray2" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>string<wbr/>To<wbr/>Array2</span><a href="#stringToArray2" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -170,10 +199,12 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h5>str: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>字符串</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in assets/core/utils/StringUtil.ts:78</li></ul></aside></li></ul></section>
<li>Defined in assets/core/utils/StringUtil.ts:105</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stringToArray3" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>string<wbr/>To<wbr/>Array3</span><a href="#stringToArray3" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -185,10 +216,12 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h5>str: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>字符串</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in assets/core/utils/StringUtil.ts:86</li></ul></aside></li></ul></section>
<li>Defined in assets/core/utils/StringUtil.ts:116</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="stringToArray4" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>string<wbr/>To<wbr/>Array4</span><a href="#stringToArray4" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
@@ -200,27 +233,37 @@
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>str: <span class="tsd-signature-type">string</span></h5></li></ul></div>
<h5>str: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>字符串</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in assets/core/utils/StringUtil.ts:94</li></ul></aside></li></ul></section>
<li>Defined in assets/core/utils/StringUtil.ts:127</li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="sub" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagStatic">Static</code> <span>sub</span><a href="#sub" 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>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="sub.sub-1">sub<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, n<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, showdot<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><a href="#sub.sub-1" 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></li>
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>字符串截取</p>
</div>
<div class="tsd-parameters">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameter-list">
<li>
<h5>str: <span class="tsd-signature-type">string</span></h5></li>
<h5>str: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography"><p>字符串</p>
</div></li>
<li>
<h5>n: <span class="tsd-signature-type">number</span></h5></li>
<h5>n: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography"><p>截取长度</p>
</div></li>
<li>
<h5>showdot: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5></li></ul></div>
<h5>showdot: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography"><p>是否把截取的部分用省略号代替</p>
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in assets/core/utils/StringUtil.ts:102</li></ul></aside></li></ul></section></section></div>
<li>Defined in assets/core/utils/StringUtil.ts:140</li></ul></aside></li></ul></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">