Skip to content

Commit 2110e80

Browse files
NichijouCCNichijouCC
committed
update(example)：样例整理
1 parent 74a7321 commit 2110e80

32 files changed

Lines changed: 357 additions & 151 deletions

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@
44
/*.log
55
/package-lock.json
66
/examples/node_modules
7+
/examples/*.lock

‎README.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,17 @@
55
web/node.js常用方法工具集
66

77
## feature
8-
1. 管理事件[【eventEmitter】](https://nichijoucc.github.io/ctool/classes/eventemitter.html),[【eventTaget】](https://nichijoucc.github.io/ctool/classes/eventtarget.html)
9-
2. 任务分割[【tasksSplite】](https://nichijoucc.github.io/ctool/globals.html#taskssplite)
10-
3. promise 在async/await下的异常管理[【wrapPromise】](https://nichijoucc.github.io/ctool/globals.html#wrappromise)
11-
4. 轻量级ws[【tinyWs】](https://nichijoucc.github.io/ctool/classes/tinyws.html)
12-
5. 重试执行任务[【retryFn】](https://nichijoucc.github.io/ctool/globals.html#retryfn)
13-
6. 唯一ID[【uuid】](https://nichijoucc.github.io/ctool/globals.html#uuid)
14-
7. 计时器[【timer】](https://nichijoucc.github.io/ctool/classes/timer.html)
15-
7. 轻量级rpc[【tinyRpc】](https://nichijoucc.github.io/ctool/classes/tinyrpc_ws.html)
8+
1. 管理事件(类似nodejs eventEmitter)[【eventEmitter】](https://nichijoucc.github.io/ctool/classes/eventemitter.html)
9+
2. 管理事件((类似nodejs eventTaget))[【eventTaget】](https://nichijoucc.github.io/ctool/classes/eventtarget.html)
10+
3. 任务分割[【tasksSplite】](https://nichijoucc.github.io/ctool/globals.html#taskssplite)
11+
4. promise 在async/await下的异常管理[【wrapPromise】](https://nichijoucc.github.io/ctool/globals.html#wrappromise)
12+
5. 轻量级ws[【tinyWs】](https://nichijoucc.github.io/ctool/classes/tinyws.html)
13+
6. 重试执行任务[【retryFn】](https://nichijoucc.github.io/ctool/globals.html#retryfn)
14+
7. 唯一ID[【uuid】](https://nichijoucc.github.io/ctool/globals.html#uuid)
15+
8. 计时器[【timer】](https://nichijoucc.github.io/ctool/classes/timer.html)
16+
9. 轻量级rpc[【tinyRpc】](https://nichijoucc.github.io/ctool/classes/tinyrpc_ws.html)
17+
10. promise结果复用[【persistPromise】](https://nichijoucc.github.io/ctool/classes/persistpromise.html)
18+
11. 副作用管理[【debuffAction】](https://nichijoucc.github.io/ctool/classes/debuffAction.html)
1619

1720
API文档：https://nichijoucc.github.io/ctool/
1821

‎docs/classes/debuffaction.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> debuff</h3>
126126
<div class="tsd-signature tsd-kind-icon">debuff<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Function</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></div>
127127
<aside class="tsd-sources">
128128
<ul>
129-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/debuffAction.ts#L21">debuffAction.ts:21</a></li>
129+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/debuffAction.ts#L21">debuffAction.ts:21</a></li>
130130
</ul>
131131
</aside>
132132
</section>
@@ -143,7 +143,7 @@ <h3>dispose</h3>
143143
<li class="tsd-description">
144144
<aside class="tsd-sources">
145145
<ul>
146-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/debuffAction.ts#L25">debuffAction.ts:25</a></li>
146+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/debuffAction.ts#L25">debuffAction.ts:25</a></li>
147147
</ul>
148148
</aside>
149149
<div class="tsd-comment tsd-typography">
@@ -165,7 +165,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3>
165165
<li class="tsd-description">
166166
<aside class="tsd-sources">
167167
<ul>
168-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/debuffAction.ts#L33">debuffAction.ts:33</a></li>
168+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/debuffAction.ts#L33">debuffAction.ts:33</a></li>
169169
</ul>
170170
</aside>
171171
<div class="tsd-comment tsd-typography">

‎docs/classes/eventemitter.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _listener</h3>
165165
<div class="tsd-signature tsd-kind-icon">_listener<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = {} as any</span></div>
166166
<aside class="tsd-sources">
167167
<ul>
168-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventEmitter.ts#L44">eventEmitter.ts:44</a></li>
168+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventEmitter.ts#L44">eventEmitter.ts:44</a></li>
169169
</ul>
170170
</aside>
171171
</section>
@@ -175,7 +175,7 @@ <h3>beactive</h3>
175175
<div class="tsd-signature tsd-kind-icon">beactive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
176176
<aside class="tsd-sources">
177177
<ul>
178-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventEmitter.ts#L48">eventEmitter.ts:48</a></li>
178+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventEmitter.ts#L48">eventEmitter.ts:48</a></li>
179179
</ul>
180180
</aside>
181181
<div class="tsd-comment tsd-typography">
@@ -197,7 +197,7 @@ <h3>emit</h3>
197197
<li class="tsd-description">
198198
<aside class="tsd-sources">
199199
<ul>
200-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventEmitter.ts#L64">eventEmitter.ts:64</a></li>
200+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventEmitter.ts#L64">eventEmitter.ts:64</a></li>
201201
</ul>
202202
</aside>
203203
<div class="tsd-comment tsd-typography">
@@ -240,7 +240,7 @@ <h3>off</h3>
240240
<li class="tsd-description">
241241
<aside class="tsd-sources">
242242
<ul>
243-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventEmitter.ts#L75">eventEmitter.ts:75</a></li>
243+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventEmitter.ts#L75">eventEmitter.ts:75</a></li>
244244
</ul>
245245
</aside>
246246
<div class="tsd-comment tsd-typography">
@@ -301,7 +301,7 @@ <h3>on</h3>
301301
<li class="tsd-description">
302302
<aside class="tsd-sources">
303303
<ul>
304-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventEmitter.ts#L54">eventEmitter.ts:54</a></li>
304+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventEmitter.ts#L54">eventEmitter.ts:54</a></li>
305305
</ul>
306306
</aside>
307307
<div class="tsd-comment tsd-typography">
@@ -362,7 +362,7 @@ <h3>remove<wbr>All<wbr>Listeners</h3>
362362
<li class="tsd-description">
363363
<aside class="tsd-sources">
364364
<ul>
365-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventEmitter.ts#L95">eventEmitter.ts:95</a></li>
365+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventEmitter.ts#L95">eventEmitter.ts:95</a></li>
366366
</ul>
367367
</aside>
368368
<div class="tsd-comment tsd-typography">
@@ -384,7 +384,7 @@ <h3>remove<wbr>Event<wbr>Listeners</h3>
384384
<li class="tsd-description">
385385
<aside class="tsd-sources">
386386
<ul>
387-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventEmitter.ts#L88">eventEmitter.ts:88</a></li>
387+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventEmitter.ts#L88">eventEmitter.ts:88</a></li>
388388
</ul>
389389
</aside>
390390
<div class="tsd-comment tsd-typography">

‎docs/classes/eventtarget.html‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ <h3>beactive</h3>
138138
<div class="tsd-signature tsd-kind-icon">beactive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
139139
<aside class="tsd-sources">
140140
<ul>
141-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventTarget.ts#L28">eventTarget.ts:28</a></li>
141+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventTarget.ts#L28">eventTarget.ts:28</a></li>
142142
</ul>
143143
</aside>
144144
<div class="tsd-comment tsd-typography">
@@ -154,7 +154,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> listener</h3>
154154
<div class="tsd-signature tsd-kind-icon">listener<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">(</span>event<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
155155
<aside class="tsd-sources">
156156
<ul>
157-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventTarget.ts#L21">eventTarget.ts:21</a></li>
157+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventTarget.ts#L21">eventTarget.ts:21</a></li>
158158
</ul>
159159
</aside>
160160
</section>
@@ -171,7 +171,7 @@ <h3>add<wbr>Event<wbr>Listener</h3>
171171
<li class="tsd-description">
172172
<aside class="tsd-sources">
173173
<ul>
174-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventTarget.ts#L34">eventTarget.ts:34</a></li>
174+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventTarget.ts#L34">eventTarget.ts:34</a></li>
175175
</ul>
176176
</aside>
177177
<div class="tsd-comment tsd-typography">
@@ -219,7 +219,7 @@ <h3>dispose</h3>
219219
<li class="tsd-description">
220220
<aside class="tsd-sources">
221221
<ul>
222-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventTarget.ts#L69">eventTarget.ts:69</a></li>
222+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventTarget.ts#L69">eventTarget.ts:69</a></li>
223223
</ul>
224224
</aside>
225225
<div class="tsd-comment tsd-typography">
@@ -241,7 +241,7 @@ <h3>raise<wbr>Event</h3>
241241
<li class="tsd-description">
242242
<aside class="tsd-sources">
243243
<ul>
244-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventTarget.ts#L58">eventTarget.ts:58</a></li>
244+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventTarget.ts#L58">eventTarget.ts:58</a></li>
245245
</ul>
246246
</aside>
247247
<div class="tsd-comment tsd-typography">
@@ -271,7 +271,7 @@ <h3>remove<wbr>All<wbr>Listeners</h3>
271271
<li class="tsd-description">
272272
<aside class="tsd-sources">
273273
<ul>
274-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventTarget.ts#L52">eventTarget.ts:52</a></li>
274+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventTarget.ts#L52">eventTarget.ts:52</a></li>
275275
</ul>
276276
</aside>
277277
<div class="tsd-comment tsd-typography">
@@ -293,7 +293,7 @@ <h3>remove<wbr>Event<wbr>Listener</h3>
293293
<li class="tsd-description">
294294
<aside class="tsd-sources">
295295
<ul>
296-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/eventTarget.ts#L42">eventTarget.ts:42</a></li>
296+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/eventTarget.ts#L42">eventTarget.ts:42</a></li>
297297
</ul>
298298
</aside>
299299
<div class="tsd-comment tsd-typography">

‎docs/classes/persistpromise.html‎

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,19 @@ <h1>Class PersistPromise</h1>
6969
<section class="tsd-panel tsd-comment">
7070
<div class="tsd-comment tsd-typography">
7171
<div class="lead">
72-
<p>复用promise结果直到promise结束；
73-
触发 dropCondition （promise.then）即解除复用，(promise.reject)即无限复用；
74-
默认dropCondition为func 结束。</p>
72+
<p>复用promise</p>
7573
</div>
7674
<dl class="tsd-comment-tags">
75+
<dt>description</dt>
76+
<dd><br/>
77+
<br/>
78+
默认dropCondition为func 结束；
79+
触发 dropCondition （promise.then）即解除复用，(promise.reject)即无限复用；
80+
</dd>
7781
<dt>example</dt>
7882
<dd><pre><code><span class="hljs-regexp">//</span>任务执行中时复用结果，执行结束时候重新执行
79-
const action = PersistPromise.create((): <span class="hljs-built_in">Promise</span>&lt;number&gt; =&gt; {
80-
<span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> <span class="hljs-built_in">Promise</span>(<span class="hljs-function"><span class="hljs-params">(resolve, reject)</span> =&gt;</span> {
83+
const action = PersistPromise.create(<span class="hljs-function"><span class="hljs-params">()</span> =&gt;</span> {
84+
<span class="hljs-keyword">return</span> <span class="hljs-keyword">new</span> <span class="hljs-built_in">Promise</span>&lt;number&gt;(<span class="hljs-function"><span class="hljs-params">(resolve, reject)</span> =&gt;</span> {
8185
<span class="hljs-built_in">setTimeout</span>(<span class="hljs-function"><span class="hljs-params">()</span> =&gt;</span> resolve(<span class="hljs-built_in">Math</span>.random()), <span class="hljs-number">100</span>)
8286
})
8387
});
@@ -144,7 +148,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
144148
<div class="tsd-signature tsd-kind-icon">doingtasks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = new Map()</span></div>
145149
<aside class="tsd-sources">
146150
<ul>
147-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/persistPromise.ts#L43">persistPromise.ts:43</a></li>
151+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/persistPromise.ts#L46">persistPromise.ts:46</a></li>
148152
</ul>
149153
</aside>
150154
</section>
@@ -161,7 +165,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3>
161165
<li class="tsd-description">
162166
<aside class="tsd-sources">
163167
<ul>
164-
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/105b799/src/persistPromise.ts#L44">persistPromise.ts:44</a></li>
168+
<li>Defined in <a href="https://github.com/NichijouCC/ctool/blob/74a7321/src/persistPromise.ts#L47">persistPromise.ts:47</a></li>
165169
</ul>
166170
</aside>
167171
<h4 class="tsd-type-parameters-title">Type parameters</h4>

0 commit comments

Comments
 (0)