Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Broch Stilley committed Feb 23, 2021
1 parent abcdb93 commit ed88b57
Show file tree
Hide file tree
Showing 17 changed files with 140 additions and 106 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions docs/classes/componentcollection.default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ <h3>components</h3>
<div class="tsd-signature tsd-kind-icon">components<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">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">CT</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = ...</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/ComponentCollection.ts#L8">ComponentCollection.ts:8</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/ComponentCollection.ts#L8">ComponentCollection.ts:8</a></li>
</ul>
</aside>
</section>
Expand All @@ -170,7 +170,7 @@ <h3>component<wbr>Types</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/ComponentCollection.ts#L77">ComponentCollection.ts:77</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/ComponentCollection.ts#L77">ComponentCollection.ts:77</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -192,7 +192,7 @@ <h3>size</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/ComponentCollection.ts#L84">ComponentCollection.ts:84</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/ComponentCollection.ts#L84">ComponentCollection.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -217,7 +217,7 @@ <h3>add</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/ComponentCollection.ts#L11">ComponentCollection.ts:11</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/ComponentCollection.ts#L11">ComponentCollection.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -240,7 +240,7 @@ <h3>get</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/ComponentCollection.ts#L40">ComponentCollection.ts:40</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/ComponentCollection.ts#L40">ComponentCollection.ts:40</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -281,7 +281,7 @@ <h3>has</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/ComponentCollection.ts#L56">ComponentCollection.ts:56</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/ComponentCollection.ts#L56">ComponentCollection.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -312,7 +312,7 @@ <h3>has<wbr>ByName</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/ComponentCollection.ts#L68">ComponentCollection.ts:68</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/ComponentCollection.ts#L68">ComponentCollection.ts:68</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -345,7 +345,7 @@ <h3>remove</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/ComponentCollection.ts#L28">ComponentCollection.ts:28</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/ComponentCollection.ts#L28">ComponentCollection.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -376,7 +376,7 @@ <h3>to<wbr>Dev<wbr>Components</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/ComponentCollection.ts#L88">ComponentCollection.ts:88</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/ComponentCollection.ts#L88">ComponentCollection.ts:88</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">CT</span><span class="tsd-signature-symbol">&gt;</span></h4>
Expand All @@ -393,7 +393,7 @@ <h3>update</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/ComponentCollection.ts#L15">ComponentCollection.ts:15</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/ComponentCollection.ts#L15">ComponentCollection.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down
26 changes: 20 additions & 6 deletions docs/classes/deventity.default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@ <h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class"><a href="deventity.default.html#components" class="tsd-kind-icon">components</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="deventity.default.html#id" class="tsd-kind-icon">id</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="deventity.default.html#state" class="tsd-kind-icon">state</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="deventity.default.html#systems" class="tsd-kind-icon">systems</a></li>
<li class="tsd-kind-property tsd-parent-kind-class"><a href="deventity.default.html#tags" class="tsd-kind-icon">tags</a></li>
</ul>
Expand All @@ -124,7 +125,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/DevEntity.ts#L19">DevEntity.ts:19</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/DevEntity.ts#L22">DevEntity.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -155,7 +156,7 @@ <h3>components</h3>
<div class="tsd-signature tsd-kind-icon">components<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">CT</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/DevEntity.ts#L15">DevEntity.ts:15</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/DevEntity.ts#L16">DevEntity.ts:16</a></li>
</ul>
</aside>
</section>
Expand All @@ -165,7 +166,17 @@ <h3>id</h3>
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/DevEntity.ts#L13">DevEntity.ts:13</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/DevEntity.ts#L14">DevEntity.ts:14</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="state" class="tsd-anchor"></a>
<h3>state</h3>
<div class="tsd-signature tsd-kind-icon">state<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EntityState</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/DevEntity.ts#L22">DevEntity.ts:22</a></li>
</ul>
</aside>
</section>
Expand All @@ -175,7 +186,7 @@ <h3>systems</h3>
<div class="tsd-signature tsd-kind-icon">systems<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></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/DevEntity.ts#L19">DevEntity.ts:19</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/DevEntity.ts#L20">DevEntity.ts:20</a></li>
</ul>
</aside>
</section>
Expand All @@ -185,7 +196,7 @@ <h3>tags</h3>
<div class="tsd-signature tsd-kind-icon">tags<span class="tsd-signature-symbol">:</span> <a href="../modules/tag.html#tag-1" class="tsd-signature-type" data-tsd-kind="Type alias">Tag</a><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/DevEntity.ts#L17">DevEntity.ts:17</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/DevEntity.ts#L18">DevEntity.ts:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -202,7 +213,7 @@ <h3>to<wbr>Table<wbr>Row</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/DevEntity.ts#L35">DevEntity.ts:35</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/DevEntity.ts#L39">DevEntity.ts:39</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DevEntityTableRow</span></h4>
Expand Down Expand Up @@ -268,6 +279,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DevEntity
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="deventity.default.html#id" class="tsd-kind-icon">id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="deventity.default.html#state" class="tsd-kind-icon">state</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class">
<a href="deventity.default.html#systems" class="tsd-kind-icon">systems</a>
</li>
Expand Down
8 changes: 4 additions & 4 deletions docs/classes/devtools.default.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/DevTools.ts#L11">DevTools.ts:11</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/DevTools.ts#L11">DevTools.ts:11</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
Expand Down Expand Up @@ -150,7 +150,7 @@ <h3>world</h3>
<div class="tsd-signature tsd-kind-icon">world<span class="tsd-signature-symbol">:</span> <a href="world.default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">CT</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/DevTools.ts#L11">DevTools.ts:11</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/DevTools.ts#L11">DevTools.ts:11</a></li>
</ul>
</aside>
</section>
Expand All @@ -167,7 +167,7 @@ <h3>entities</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/DevTools.ts#L46">DevTools.ts:46</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/DevTools.ts#L46">DevTools.ts:46</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -199,7 +199,7 @@ <h3>system<wbr>Components</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/c8eb8d1/src/DevTools.ts#L24">DevTools.ts:24</a></li>
<li>Defined in <a href="https://github.com/brochington/ecstatic/blob/abcdb93/src/DevTools.ts#L24">DevTools.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit ed88b57

Please sign in to comment.