Skip to content

Commit 06f3fe2

Browse files
bryanjosbryanjos
committed
Update docs
1 parent c61d3f0 commit 06f3fe2

18 files changed

+625
-2169
lines changed

‎docs/assets/js/search.js‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/classes/_processes_schedulers_default_scheduler_.defaultscheduler.html renamed to docs/classes/defaultscheduler.html

Lines changed: 67 additions & 72 deletions
Large diffs are not rendered by default.

docs/classes/_processes_mailbox_.mailbox.html renamed to docs/classes/mailbox.html

Lines changed: 47 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,6 @@
3838
</div>
3939
<input type="checkbox" id="tsd-filter-inherited" checked />
4040
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41-
<input type="checkbox" id="tsd-filter-externals" checked />
42-
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
4341
<input type="checkbox" id="tsd-filter-only-exported" />
4442
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
4543
</div>
@@ -56,10 +54,7 @@
5654
<a href="../globals.html">Globals</a>
5755
</li>
5856
<li>
59-
<a href="../modules/_processes_mailbox_.html">&quot;processes/mailbox&quot;</a>
60-
</li>
61-
<li>
62-
<a href="_processes_mailbox_.mailbox.html">Mailbox</a>
57+
<a href="mailbox.html">Mailbox</a>
6358
</li>
6459
</ul>
6560
<h1>Class Mailbox</h1>
@@ -84,22 +79,22 @@ <h2>Index</h2>
8479
<section class="tsd-index-section ">
8580
<h3>Constructors</h3>
8681
<ul class="tsd-index-list">
87-
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_processes_mailbox_.mailbox.html#constructor" class="tsd-kind-icon">constructor</a></li>
82+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="mailbox.html#constructor" class="tsd-kind-icon">constructor</a></li>
8883
</ul>
8984
</section>
9085
<section class="tsd-index-section ">
9186
<h3>Properties</h3>
9287
<ul class="tsd-index-list">
93-
<li class="tsd-kind-property tsd-parent-kind-class"><a href="_processes_mailbox_.mailbox.html#messages" class="tsd-kind-icon">messages</a></li>
88+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="mailbox.html#messages" class="tsd-kind-icon">messages</a></li>
9489
</ul>
9590
</section>
9691
<section class="tsd-index-section ">
9792
<h3>Methods</h3>
9893
<ul class="tsd-index-list">
99-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_processes_mailbox_.mailbox.html#deliver" class="tsd-kind-icon">deliver</a></li>
100-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_processes_mailbox_.mailbox.html#get" class="tsd-kind-icon">get</a></li>
101-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_processes_mailbox_.mailbox.html#isempty" class="tsd-kind-icon">is<wbr>Empty</a></li>
102-
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_processes_mailbox_.mailbox.html#removeat" class="tsd-kind-icon">remove<wbr>At</a></li>
94+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mailbox.html#deliver" class="tsd-kind-icon">deliver</a></li>
95+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mailbox.html#get" class="tsd-kind-icon">get</a></li>
96+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mailbox.html#isempty" class="tsd-kind-icon">is<wbr>Empty</a></li>
97+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="mailbox.html#removeat" class="tsd-kind-icon">remove<wbr>At</a></li>
10398
</ul>
10499
</section>
105100
</div>
@@ -111,16 +106,16 @@ <h2>Constructors</h2>
111106
<a name="constructor" class="tsd-anchor"></a>
112107
<h3>constructor</h3>
113108
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
114-
<li class="tsd-signature tsd-kind-icon">new <wbr>Mailbox<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_processes_mailbox_.mailbox.html" class="tsd-signature-type">Mailbox</a></li>
109+
<li class="tsd-signature tsd-kind-icon">new <wbr>Mailbox<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="mailbox.html" class="tsd-signature-type">Mailbox</a></li>
115110
</ul>
116111
<ul class="tsd-descriptions">
117112
<li class="tsd-description">
118113
<aside class="tsd-sources">
119114
<ul>
120-
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/292e035/src/processes/mailbox.ts#L2">processes/mailbox.ts:2</a></li>
115+
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/c61d3f0/src/processes/mailbox.ts#L2">processes/mailbox.ts:2</a></li>
121116
</ul>
122117
</aside>
123-
<h4 class="tsd-returns-title">Returns <a href="_processes_mailbox_.mailbox.html" class="tsd-signature-type">Mailbox</a></h4>
118+
<h4 class="tsd-returns-title">Returns <a href="mailbox.html" class="tsd-signature-type">Mailbox</a></h4>
124119
</li>
125120
</ul>
126121
</section>
@@ -133,7 +128,7 @@ <h3>messages</h3>
133128
<div class="tsd-signature tsd-kind-icon">messages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></div>
134129
<aside class="tsd-sources">
135130
<ul>
136-
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/292e035/src/processes/mailbox.ts#L2">processes/mailbox.ts:2</a></li>
131+
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/c61d3f0/src/processes/mailbox.ts#L2">processes/mailbox.ts:2</a></li>
137132
</ul>
138133
</aside>
139134
</section>
@@ -150,7 +145,7 @@ <h3>deliver</h3>
150145
<li class="tsd-description">
151146
<aside class="tsd-sources">
152147
<ul>
153-
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/292e035/src/processes/mailbox.ts#L7">processes/mailbox.ts:7</a></li>
148+
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/c61d3f0/src/processes/mailbox.ts#L7">processes/mailbox.ts:7</a></li>
154149
</ul>
155150
</aside>
156151
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -173,7 +168,7 @@ <h3>get</h3>
173168
<li class="tsd-description">
174169
<aside class="tsd-sources">
175170
<ul>
176-
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/292e035/src/processes/mailbox.ts#L12">processes/mailbox.ts:12</a></li>
171+
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/c61d3f0/src/processes/mailbox.ts#L12">processes/mailbox.ts:12</a></li>
177172
</ul>
178173
</aside>
179174
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h4>
@@ -190,7 +185,7 @@ <h3>is<wbr>Empty</h3>
190185
<li class="tsd-description">
191186
<aside class="tsd-sources">
192187
<ul>
193-
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/292e035/src/processes/mailbox.ts#L16">processes/mailbox.ts:16</a></li>
188+
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/c61d3f0/src/processes/mailbox.ts#L16">processes/mailbox.ts:16</a></li>
194189
</ul>
195190
</aside>
196191
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
@@ -207,7 +202,7 @@ <h3>remove<wbr>At</h3>
207202
<li class="tsd-description">
208203
<aside class="tsd-sources">
209204
<ul>
210-
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/292e035/src/processes/mailbox.ts#L20">processes/mailbox.ts:20</a></li>
205+
<li>Defined in <a href="https://github.com/elixirscript/processes/blob/c61d3f0/src/processes/mailbox.ts#L20">processes/mailbox.ts:20</a></li>
211206
</ul>
212207
</aside>
213208
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -228,61 +223,61 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span
228223
<li class="globals ">
229224
<a href="../globals.html"><em>Globals</em></a>
230225
</li>
231-
<li class=" tsd-kind-external-module">
232-
<a href="../modules/_index_.html">"index"</a>
233-
</li>
234-
<li class="current tsd-kind-external-module">
235-
<a href="../modules/_processes_mailbox_.html">"processes/mailbox"</a>
236-
</li>
237-
<li class=" tsd-kind-external-module">
238-
<a href="../modules/_processes_process_.html">"processes/process"</a>
239-
</li>
240-
<li class=" tsd-kind-external-module">
241-
<a href="../modules/_processes_process_system_.html">"processes/process_<wbr>system"</a>
242-
</li>
243-
<li class=" tsd-kind-external-module">
244-
<a href="../modules/_processes_schedulers_default_scheduler_.html">"processes/schedulers/default_<wbr>scheduler"</a>
245-
</li>
246-
<li class=" tsd-kind-external-module">
247-
<a href="../modules/_processes_schedulers_process_queue_.html">"processes/schedulers/process_<wbr>queue"</a>
248-
</li>
249-
<li class=" tsd-kind-external-module">
250-
<a href="../modules/_processes_schedulers_request_animation_scheduler_.html">"processes/schedulers/request_<wbr>animation_<wbr>scheduler"</a>
251-
</li>
252-
<li class=" tsd-kind-external-module">
253-
<a href="../modules/_processes_states_.html">"processes/states"</a>
254-
</li>
255226
</ul>
256227
</nav>
257228
<nav class="tsd-navigation secondary menu-sticky">
258229
<ul class="before-current">
230+
<li class=" tsd-kind-class">
231+
<a href="defaultscheduler.html" class="tsd-kind-icon">Default<wbr>Scheduler</a>
232+
</li>
259233
</ul>
260234
<ul class="current">
261-
<li class="current tsd-kind-class tsd-parent-kind-external-module">
262-
<a href="_processes_mailbox_.mailbox.html" class="tsd-kind-icon">Mailbox</a>
235+
<li class="current tsd-kind-class">
236+
<a href="mailbox.html" class="tsd-kind-icon">Mailbox</a>
263237
<ul>
264238
<li class=" tsd-kind-constructor tsd-parent-kind-class">
265-
<a href="_processes_mailbox_.mailbox.html#constructor" class="tsd-kind-icon">constructor</a>
239+
<a href="mailbox.html#constructor" class="tsd-kind-icon">constructor</a>
266240
</li>
267241
<li class=" tsd-kind-property tsd-parent-kind-class">
268-
<a href="_processes_mailbox_.mailbox.html#messages" class="tsd-kind-icon">messages</a>
242+
<a href="mailbox.html#messages" class="tsd-kind-icon">messages</a>
269243
</li>
270244
<li class=" tsd-kind-method tsd-parent-kind-class">
271-
<a href="_processes_mailbox_.mailbox.html#deliver" class="tsd-kind-icon">deliver</a>
245+
<a href="mailbox.html#deliver" class="tsd-kind-icon">deliver</a>
272246
</li>
273247
<li class=" tsd-kind-method tsd-parent-kind-class">
274-
<a href="_processes_mailbox_.mailbox.html#get" class="tsd-kind-icon">get</a>
248+
<a href="mailbox.html#get" class="tsd-kind-icon">get</a>
275249
</li>
276250
<li class=" tsd-kind-method tsd-parent-kind-class">
277-
<a href="_processes_mailbox_.mailbox.html#isempty" class="tsd-kind-icon">is<wbr>Empty</a>
251+
<a href="mailbox.html#isempty" class="tsd-kind-icon">is<wbr>Empty</a>
278252
</li>
279253
<li class=" tsd-kind-method tsd-parent-kind-class">
280-
<a href="_processes_mailbox_.mailbox.html#removeat" class="tsd-kind-icon">remove<wbr>At</a>
254+
<a href="mailbox.html#removeat" class="tsd-kind-icon">remove<wbr>At</a>
281255
</li>
282256
</ul>
283257
</li>
284258
</ul>
285259
<ul class="after-current">
260+
<li class=" tsd-kind-class">
261+
<a href="process.html" class="tsd-kind-icon">Process</a>
262+
</li>
263+
<li class=" tsd-kind-class">
264+
<a href="processqueue.html" class="tsd-kind-icon">Process<wbr>Queue</a>
265+
</li>
266+
<li class=" tsd-kind-class">
267+
<a href="processsystem.html" class="tsd-kind-icon">Process<wbr>System</a>
268+
</li>
269+
<li class=" tsd-kind-class">
270+
<a href="requestanimationscheduler.html" class="tsd-kind-icon">Request<wbr>Animation<wbr>Scheduler</a>
271+
</li>
272+
<li class=" tsd-kind-function tsd-is-not-exported">
273+
<a href="../globals.html#is_receive" class="tsd-kind-icon">is_<wbr>receive</a>
274+
</li>
275+
<li class=" tsd-kind-function tsd-is-not-exported">
276+
<a href="../globals.html#is_sleep" class="tsd-kind-icon">is_<wbr>sleep</a>
277+
</li>
278+
<li class=" tsd-kind-function tsd-is-not-exported">
279+
<a href="../globals.html#receive_timed_out" class="tsd-kind-icon">receive_<wbr>timed_<wbr>out</a>
280+
</li>
286281
</ul>
287282
</nav>
288283
</div>

0 commit comments

Comments
 (0)