Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@2A5F
2A5F committed Dec 25, 2020
1 parent 5b2c9c4 commit ed1dc55
Show file tree
Hide file tree
Showing 74 changed files with 621 additions and 999 deletions.
7 changes: 7 additions & 0 deletions .vscode/tasks.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,13 @@
"type": "npm",
"script": "test",
"problemMatcher": []
},
{
"type": "npm",
"script": "doc",
"problemMatcher": [],
"label": "npm: doc",
"detail": "typedoc --out docs src --exclude **/*.test.ts --name \"Sugar.js\""
}
]
}
2 changes: 1 addition & 1 deletion docs/assets/js/search.json
View file

Large diffs are not rendered by default.

395 changes: 0 additions & 395 deletions docs/classes/_event_.atevent.html
View file

This file was deleted.

29 changes: 13 additions & 16 deletions docs/classes/_event_.pevents.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> #regs</h3>
<div class="tsd-signature tsd-kind-icon">#regs<span class="tsd-signature-symbol">:</span> <a href="_map_.mutableexmap.html" class="tsd-signature-type">MutableExMap</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><a href="_event_.tevent.html" class="tsd-signature-type">TEvent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = MutMapEx(new Map&lt;string, TEvent&lt;any&gt;&gt;())</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L43">src/event.ts:43</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L43">src/event.ts:43</a></li>
</ul>
</aside>
</section>
Expand All @@ -133,7 +133,7 @@ <h3>emit</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L46">src/event.ts:46</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L46">src/event.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -164,7 +164,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L48">src/event.ts:48</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L48">src/event.ts:48</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -192,7 +192,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L50">src/event.ts:50</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L50">src/event.ts:50</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -231,7 +231,7 @@ <h3>off</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L78">src/event.ts:78</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L78">src/event.ts:78</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -280,7 +280,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L80">src/event.ts:80</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L80">src/event.ts:80</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -326,7 +326,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L82">src/event.ts:82</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L82">src/event.ts:82</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -383,7 +383,7 @@ <h3>on</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L56">src/event.ts:56</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L56">src/event.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -432,7 +432,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L58">src/event.ts:58</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L58">src/event.ts:58</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -478,7 +478,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L60">src/event.ts:60</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L60">src/event.ts:60</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -535,7 +535,7 @@ <h3>once</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L67">src/event.ts:67</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L67">src/event.ts:67</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -584,7 +584,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L69">src/event.ts:69</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L69">src/event.ts:69</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -630,7 +630,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L71">src/event.ts:71</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L71">src/event.ts:71</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -690,9 +690,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
<a href="_event_.atevent.html" class="tsd-kind-icon">ATEvent</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module">
Expand Down
15 changes: 6 additions & 9 deletions docs/classes/_event_.tevent.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> #fns</h3>
<div class="tsd-signature tsd-kind-icon">#fns<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">A</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">&gt;</span><span class="tsd-signature-symbol"> = new Set&lt;(...args: A) &#x3D;&gt; void&gt;()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L6">src/event.ts:6</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L6">src/event.ts:6</a></li>
</ul>
</aside>
</section>
Expand All @@ -133,7 +133,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> #onces</h3>
<div class="tsd-signature tsd-kind-icon">#onces<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Set</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">A</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">&gt;</span><span class="tsd-signature-symbol"> = new Set&lt;(...args: A) &#x3D;&gt; void&gt;()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L7">src/event.ts:7</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L7">src/event.ts:7</a></li>
</ul>
</aside>
</section>
Expand All @@ -150,7 +150,7 @@ <h3>emit</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L10">src/event.ts:10</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L10">src/event.ts:10</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -178,7 +178,7 @@ <h3>off</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L35">src/event.ts:35</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L35">src/event.ts:35</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -224,7 +224,7 @@ <h3>on</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L24">src/event.ts:24</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L24">src/event.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -270,7 +270,7 @@ <h3>once</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/event.ts#L29">src/event.ts:29</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/event.ts#L29">src/event.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -321,9 +321,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
<a href="_event_.atevent.html" class="tsd-kind-icon">ATEvent</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="_event_.pevents.html" class="tsd-kind-icon">PEvents</a>
</li>
Expand Down
12 changes: 6 additions & 6 deletions docs/classes/_lazy_.lazy.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/lazy.ts#L12">src/lazy.ts:12</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/lazy.ts#L12">src/lazy.ts:12</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -172,7 +172,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> #init</h3>
<div class="tsd-signature tsd-kind-icon">#init<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> =&gt; </span><span class="tsd-signature-type">T</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/lazy.ts#L12">src/lazy.ts:12</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/lazy.ts#L12">src/lazy.ts:12</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
Expand All @@ -198,7 +198,7 @@ <h3>val</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_box_.box.html">Box</a>.<a href="../interfaces/_box_.box.html#val">val</a></p>
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/lazy.ts#L10">src/lazy.ts:10</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/lazy.ts#L10">src/lazy.ts:10</a></li>
</ul>
</aside>
</section>
Expand All @@ -215,7 +215,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/lazy.ts#L18">src/lazy.ts:18</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/lazy.ts#L18">src/lazy.ts:18</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -237,7 +237,7 @@ <h3>got</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/lazy.ts#L25">src/lazy.ts:25</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/lazy.ts#L25">src/lazy.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -259,7 +259,7 @@ <h3>reget</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/lazy.ts#L30">src/lazy.ts:30</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/lazy.ts#L30">src/lazy.ts:30</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
16 changes: 8 additions & 8 deletions docs/classes/_map_.exmap.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/map.ts#L18">src/map.ts:18</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/map.ts#L18">src/map.ts:18</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -168,7 +168,7 @@ <h3>val</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_box_.box.html">Box</a>.<a href="../interfaces/_box_.box.html#val">val</a></p>
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/map.ts#L19">src/map.ts:19</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/map.ts#L19">src/map.ts:19</a></li>
</ul>
</aside>
</section>
Expand All @@ -185,7 +185,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/map.ts#L21">src/map.ts:21</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/map.ts#L21">src/map.ts:21</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -209,7 +209,7 @@ <h3>get<wbr>And<wbr>Then</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/map.ts#L38">src/map.ts:38</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/map.ts#L38">src/map.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -249,7 +249,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</spa
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/map.ts#L40">src/map.ts:40</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/map.ts#L40">src/map.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -277,7 +277,7 @@ <h3>get<wbr>OrDefault</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/map.ts#L29">src/map.ts:29</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/map.ts#L29">src/map.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -308,7 +308,7 @@ <h3>has</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/map.ts#L24">src/map.ts:24</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/map.ts#L24">src/map.ts:24</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -331,7 +331,7 @@ <h3>try<wbr>Get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/a6fea84/src/map.ts#L52">src/map.ts:52</a></li>
<li>Defined in <a href="https://github.com/libsugar/sugar.js/blob/5b2c9c4/src/map.ts#L52">src/map.ts:52</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit ed1dc55

Please sign in to comment.