新增doc

This commit is contained in:
yhh
2020-11-20 14:07:34 +08:00
parent 562bacbe22
commit 7eab688d9c
589 changed files with 179126 additions and 326 deletions

View File

@@ -0,0 +1,623 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>StringUtils | @esengine/egret-framework</title>
<meta name="description" content="Documentation for @esengine/egret-framework">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">@esengine/egret-framework</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>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_ecs_utils_stringutils_.html">&quot;ECS/Utils/StringUtils&quot;</a>
</li>
<li>
<a href="_ecs_utils_stringutils_.stringutils.html">StringUtils</a>
</li>
</ul>
<h1>Class StringUtils</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">StringUtils</span>
</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 tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#specialsigns" class="tsd-kind-icon">special<wbr>Signs</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#cutoff" class="tsd-kind-icon">cut<wbr>Off</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#htmlspecialchars" class="tsd-kind-icon">html<wbr>Special<wbr>Chars</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#iswhitespace" class="tsd-kind-icon">is<wbr>White<wbr>Space</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#ltrim" class="tsd-kind-icon">l<wbr>Trim</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#matchchineseword" class="tsd-kind-icon">match<wbr>Chinese<wbr>Word</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#rtrim" class="tsd-kind-icon">r<wbr>Trim</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#replacematch" class="tsd-kind-icon">replace<wbr>Match</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#reverse" class="tsd-kind-icon">reverse</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#strreplace" class="tsd-kind-icon">str<wbr>Replace</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#trim" class="tsd-kind-icon">trim</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_ecs_utils_stringutils_.stringutils.html#zfill" class="tsd-kind-icon">zfill</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a name="specialsigns" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-flagPrivate">Private</span> special<wbr>Signs</h3>
<div class="tsd-signature tsd-kind-icon">special<wbr>Signs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = [&#x27;&amp;&#x27;, &#x27;&amp;amp;&#x27;,&#x27;&lt;&#x27;, &#x27;&amp;lt;&#x27;,&#x27;&gt;&#x27;, &#x27;&amp;gt;&#x27;,&#x27;&quot;&#x27;, &#x27;&amp;quot;&#x27;,&quot;&#x27;&quot;, &#x27;&amp;apos;&#x27;,&#x27;®&#x27;, &#x27;&amp;reg;&#x27;,&#x27;©&#x27;, &#x27;&amp;copy;&#x27;,&#x27;&#x27;, &#x27;&amp;trade;&#x27;,]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L5">src/ECS/Utils/StringUtils.ts:5</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>特殊符号字符串</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="cutoff" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> cut<wbr>Off</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">cut<wbr>Off<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, start<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, len<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, order<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L203">src/ECS/Utils/StringUtils.ts:203</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>截断某段字符串</p>
</div>
</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>目标字符串</p>
</div>
</li>
<li>
<h5>start: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>需要截断的起始索引</p>
</div>
</li>
<li>
<h5>len: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>截断长度</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> order: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
<div class="tsd-comment tsd-typography">
<p>顺序true从字符串头部开始计算false从字符串尾巴开始结算。</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>截断后的字符串</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="htmlspecialchars" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> html<wbr>Special<wbr>Chars</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">html<wbr>Special<wbr>Chars<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, reversion<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L113">src/ECS/Utils/StringUtils.ts:113</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>用html实体换掉字符窜中的特殊字符</p>
</div>
</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>需要替换的字符串</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> reversion: <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>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>换掉特殊字符后的字符串</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="iswhitespace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> is<wbr>White<wbr>Space</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">is<wbr>White<wbr>Space<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">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L70">src/ECS/Utils/StringUtils.ts:70</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>返回该字符是否为空白字符</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>str: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>返回该字符是否为空白字符</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="ltrim" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> l<wbr>Trim</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">l<wbr>Trim<span class="tsd-signature-symbol">(</span>target<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L32">src/ECS/Utils/StringUtils.ts:32</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>去除字符串左端的空白字符</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>target: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>目标字符串</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-method tsd-parent-kind-class tsd-is-static">
<a name="matchchineseword" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> match<wbr>Chinese<wbr>Word</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">match<wbr>Chinese<wbr>Word<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">string</span><span class="tsd-signature-symbol">[]</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L21">src/ECS/Utils/StringUtils.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>匹配中文字符</p>
</div>
</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>需要匹配的字符串</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="rtrim" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> r<wbr>Trim</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">r<wbr>Trim<span class="tsd-signature-symbol">(</span>target<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L45">src/ECS/Utils/StringUtils.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>去除字符串右端的空白字符</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>target: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>目标字符串</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-method tsd-parent-kind-class tsd-is-static">
<a name="replacematch" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> replace<wbr>Match</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">replace<wbr>Match<span class="tsd-signature-symbol">(</span>mainStr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, targetStr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, replaceStr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, caseMark<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L84">src/ECS/Utils/StringUtils.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>返回执行替换后的字符串</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>mainStr: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>待查找字符串</p>
</div>
</li>
<li>
<h5>targetStr: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>目标字符串</p>
</div>
</li>
<li>
<h5>replaceStr: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>替换字符串</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> caseMark: <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>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>返回执行替换后的字符串</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="reverse" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> reverse</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">reverse<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">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L187">src/ECS/Utils/StringUtils.ts:187</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>翻转字符串</p>
</div>
</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>字符串</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>翻转后的字符串</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="strreplace" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> str<wbr>Replace</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">str<wbr>Replace<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, rStr<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-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 <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L223">src/ECS/Utils/StringUtils.ts:223</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>{0} 字符替换</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>str: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>rStr: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
</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-method tsd-parent-kind-class tsd-is-static">
<a name="trim" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> trim</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">trim<span class="tsd-signature-symbol">(</span>target<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L58">src/ECS/Utils/StringUtils.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>返回一个去除2段空白字符的字符串</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>target: <span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
<p>返回一个去除2段空白字符的字符串</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="zfill" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> zfill</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">zfill<span class="tsd-signature-symbol">(</span>str<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, width<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></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/esengine/egret-framework/blob/562bacb/source/src/ECS/Utils/StringUtils.ts#L153">src/ECS/Utils/StringUtils.ts:153</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>给数字字符前面添 &quot;0&quot;</p>
</div>
<pre>
trace( StringFormat.zfill('1') );
// 01
trace( StringFormat.zfill('16', 5) );
// 00016
trace( StringFormat.zfill('-3', 3) );
// -03
</pre>
</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>要进行处理的字符串</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> width: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 2</span></h5>
<div class="tsd-comment tsd-typography">
<p>处理后字符串的长度,
如果str.length &gt;= width将不做任何处理直接返回原始的str。</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/_ecs_utils_stringutils_.html">&quot;ECS/<wbr>Utils/<wbr>String<wbr>Utils&quot;</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
<a href="_ecs_utils_stringutils_.stringutils.html" class="tsd-kind-icon">String<wbr>Utils</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#specialsigns" class="tsd-kind-icon">special<wbr>Signs</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#cutoff" class="tsd-kind-icon">cut<wbr>Off</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#htmlspecialchars" class="tsd-kind-icon">html<wbr>Special<wbr>Chars</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#iswhitespace" class="tsd-kind-icon">is<wbr>White<wbr>Space</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#ltrim" class="tsd-kind-icon">l<wbr>Trim</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#matchchineseword" class="tsd-kind-icon">match<wbr>Chinese<wbr>Word</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#rtrim" class="tsd-kind-icon">r<wbr>Trim</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#replacematch" class="tsd-kind-icon">replace<wbr>Match</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#reverse" class="tsd-kind-icon">reverse</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#strreplace" class="tsd-kind-icon">str<wbr>Replace</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#trim" class="tsd-kind-icon">trim</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_ecs_utils_stringutils_.stringutils.html#zfill" class="tsd-kind-icon">zfill</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</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-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</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/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>