更新文档

This commit is contained in:
dgflash
2022-09-02 15:14:33 +08:00
parent a7eeba8659
commit 8bcbc8179b
28 changed files with 464 additions and 379 deletions

View File

@@ -290,7 +290,7 @@
<div class="tsd-comment tsd-typography"><p>在指定对象上注册一个倒计时的回调管理器</p>
<h3>Returns</h3>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-3">export</span><span class="hl-1"> </span><span class="hl-6">class</span><span class="hl-1"> </span><span class="hl-2">Test</span><span class="hl-1"> </span><span class="hl-6">extends</span><span class="hl-1"> </span><span class="hl-2">Component</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">private</span><span class="hl-1"> </span><span class="hl-0">timeId</span><span class="hl-1">!: </span><span class="hl-2">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-5">start</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-9">// 在指定对象上注册一个倒计时的回调管理器</span><br/><span class="hl-1"> </span><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-0">timeId</span><span class="hl-1"> = </span><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-5">register</span><span class="hl-1">(</span><span class="hl-6">this</span><span class="hl-1">, </span><span class="hl-4">&quot;countDown&quot;</span><span class="hl-1">, </span><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-0">onSecond</span><span class="hl-1">, </span><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-0">onComplete</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-6">private</span><span class="hl-1"> </span><span class="hl-5">onSecond</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-4">&quot;每秒触发一次&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-6">private</span><span class="hl-1"> </span><span class="hl-5">onComplete</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-4">&quot;倒计时完成触发&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-8">class</span><span class="hl-1"> </span><span class="hl-4">Test</span><span class="hl-1"> </span><span class="hl-8">extends</span><span class="hl-1"> </span><span class="hl-4">Component</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">private</span><span class="hl-1"> </span><span class="hl-0">timeId</span><span class="hl-1">!: </span><span class="hl-4">string</span><span class="hl-1">;</span><br/><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-7">start</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">// 在指定对象上注册一个倒计时的回调管理器</span><br/><span class="hl-1"> </span><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-0">timeId</span><span class="hl-1"> = </span><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-7">register</span><span class="hl-1">(</span><span class="hl-8">this</span><span class="hl-1">, </span><span class="hl-6">&quot;countDown&quot;</span><span class="hl-1">, </span><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-0">onSecond</span><span class="hl-1">, </span><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-0">onComplete</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1"> </span><br/><span class="hl-1"> </span><span class="hl-8">private</span><span class="hl-1"> </span><span class="hl-7">onSecond</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-6">&quot;每秒触发一次&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-8">private</span><span class="hl-1"> </span><span class="hl-7">onComplete</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-7">log</span><span class="hl-1">(</span><span class="hl-6">&quot;倒计时完成触发&quot;</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<div class="tsd-parameters">
@@ -334,7 +334,7 @@
<h3>Returns</h3><p>string</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-5">schedule</span><span class="hl-1">(()</span><span class="hl-6">=&gt;</span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-9">// 每秒触发一次</span><br/><span class="hl-1">}, </span><span class="hl-7">1000</span><span class="hl-1">);</span>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-7">schedule</span><span class="hl-1">(()</span><span class="hl-8">=&gt;</span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">// 每秒触发一次</span><br/><span class="hl-1">}, </span><span class="hl-9">1000</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
@@ -360,7 +360,7 @@
<h3>Returns</h3><p>string</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-5">scheduleOnce</span><span class="hl-1">(()</span><span class="hl-6">=&gt;</span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-9">// 1秒后触发一次后不会在触发</span><br/><span class="hl-1">}, </span><span class="hl-7">1000</span><span class="hl-1">);</span>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-7">scheduleOnce</span><span class="hl-1">(()</span><span class="hl-8">=&gt;</span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">// 1秒后触发一次后不会在触发</span><br/><span class="hl-1">}, </span><span class="hl-9">1000</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">
@@ -401,7 +401,7 @@
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>在指定对象上注销一个倒计时的回调管理器</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-3">export</span><span class="hl-1"> </span><span class="hl-6">class</span><span class="hl-1"> </span><span class="hl-2">Test</span><span class="hl-1"> </span><span class="hl-6">extends</span><span class="hl-1"> </span><span class="hl-2">Component</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-6">private</span><span class="hl-1"> </span><span class="hl-0">timeId</span><span class="hl-1">!: </span><span class="hl-2">string</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-5">start</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-0">timeId</span><span class="hl-1"> = </span><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-5">register</span><span class="hl-1">(</span><span class="hl-6">this</span><span class="hl-1">, </span><span class="hl-4">&quot;countDown&quot;</span><span class="hl-1">, </span><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-0">onSecond</span><span class="hl-1">, </span><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-0">onComplete</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-5">onDestroy</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-9">// 在指定对象上注销一个倒计时的回调管理器</span><br/><span class="hl-1"> </span><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-5">unRegister</span><span class="hl-1">(</span><span class="hl-6">this</span><span class="hl-1">.</span><span class="hl-0">timeId</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-5">export</span><span class="hl-1"> </span><span class="hl-8">class</span><span class="hl-1"> </span><span class="hl-4">Test</span><span class="hl-1"> </span><span class="hl-8">extends</span><span class="hl-1"> </span><span class="hl-4">Component</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-8">private</span><span class="hl-1"> </span><span class="hl-0">timeId</span><span class="hl-1">!: </span><span class="hl-4">string</span><span class="hl-1">;</span><br/><br/><span class="hl-1"> </span><span class="hl-7">start</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-0">timeId</span><span class="hl-1"> = </span><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-7">register</span><span class="hl-1">(</span><span class="hl-8">this</span><span class="hl-1">, </span><span class="hl-6">&quot;countDown&quot;</span><span class="hl-1">, </span><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-0">onSecond</span><span class="hl-1">, </span><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-0">onComplete</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><br/><span class="hl-1"> </span><span class="hl-7">onDestroy</span><span class="hl-1">() {</span><br/><span class="hl-1"> </span><span class="hl-3">// 在指定对象上注销一个倒计时的回调管理器</span><br/><span class="hl-1"> </span><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-7">unRegister</span><span class="hl-1">(</span><span class="hl-8">this</span><span class="hl-1">.</span><span class="hl-0">timeId</span><span class="hl-1">);</span><br/><span class="hl-1"> }</span><br/><span class="hl-1">}</span>
</code></pre>
</div>
<div class="tsd-parameters">
@@ -421,7 +421,7 @@
<li class="tsd-description">
<div class="tsd-comment tsd-typography"><p>删除一个时间触发器</p>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-6">var</span><span class="hl-1"> </span><span class="hl-0">uuid</span><span class="hl-1"> = </span><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-5">schedule</span><span class="hl-1">(()</span><span class="hl-6">=&gt;</span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-9">// 每秒触发一次</span><br/><span class="hl-1">}, </span><span class="hl-7">1000</span><span class="hl-1">);</span><br/><br/><span class="hl-9">// 删除指定标识的触发器</span><br/><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-5">unschedule</span><span class="hl-1">(</span><span class="hl-0">uuid</span><span class="hl-1">);</span>
<h3>Example</h3><pre><code class="language-ts"><span class="hl-8">var</span><span class="hl-1"> </span><span class="hl-0">uuid</span><span class="hl-1"> = </span><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-7">schedule</span><span class="hl-1">(()</span><span class="hl-8">=&gt;</span><span class="hl-1">{</span><br/><span class="hl-1"> </span><span class="hl-3">// 每秒触发一次</span><br/><span class="hl-1">}, </span><span class="hl-9">1000</span><span class="hl-1">);</span><br/><br/><span class="hl-3">// 删除指定标识的触发器</span><br/><span class="hl-0">oops</span><span class="hl-1">.</span><span class="hl-0">timer</span><span class="hl-1">.</span><span class="hl-7">unschedule</span><span class="hl-1">(</span><span class="hl-0">uuid</span><span class="hl-1">);</span>
</code></pre>
</div>
<div class="tsd-parameters">