Skip to content

Commit

Permalink
Update API docs to match new functionality
Browse files Browse the repository at this point in the history
  • Loading branch information
@flut1
flut1 committed Feb 25, 2019
1 parent 98d7e85 commit 0065c0e
Show file tree
Hide file tree
Showing 30 changed files with 1,013 additions and 644 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* private => protected
* remove interfaces
* typings
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

89 changes: 50 additions & 39 deletions docs/classes/seng_event.abstractevent.html
View file

Large diffs are not rendered by default.

172 changes: 94 additions & 78 deletions docs/classes/seng_event.eventdispatcher.html
View file

Large diffs are not rendered by default.

46 changes: 17 additions & 29 deletions docs/classes/seng_event.eventlistenerdata.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/80b2a2c/src/lib/EventListenerData.ts#L27">lib/EventListenerData.ts:27</a></li>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/98d7e85/src/lib/EventListenerData.ts#L27">lib/EventListenerData.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -183,16 +183,16 @@ <h5>handler: <a href="../modules/seng_event_lib_eventtypings.html#eventhandlerfo
<h5>useCapture: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set to the <em>useCapture</em> argument passed to <a href="seng_event.eventdispatcher.html#addeventlistener">addEventListener</a></p>
<p>Set to the <code>useCapture</code> argument passed to <a href="seng_event.eventdispatcher.html#addeventlistener">addEventListener</a></p>
</div>
</div>
</li>
<li>
<h5>priority: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Set to the <em>priority</em> argument passed to <a href="seng_event.eventdispatcher.html#addeventlistener">addEventListener</a>.
Used to sort the listener within the [[EventDispatcher.<em>listeners|</em>listeners]] object of the EventDispatcher</p>
<p>Set to the <code>priority</code> argument passed to <a href="seng_event.eventdispatcher.html#addeventlistener">addEventListener</a>.
Used to sort the listener within the <a href="seng_event.eventdispatcher.html#listeners">listeners</a> object of the EventDispatcher</p>
</div>
</div>
</li>
Expand All @@ -210,7 +210,7 @@ <h3>dispatcher</h3>
<div class="tsd-signature tsd-kind-icon">dispatcher<span class="tsd-signature-symbol">:</span> <a href="seng_event.eventdispatcher.html" class="tsd-signature-type">EventDispatcher</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TEvent</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/80b2a2c/src/lib/EventListenerData.ts#L17">lib/EventListenerData.ts:17</a></li>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/98d7e85/src/lib/EventListenerData.ts#L17">lib/EventListenerData.ts:17</a></li>
</ul>
</aside>
</section>
Expand All @@ -220,7 +220,7 @@ <h3>handler</h3>
<div class="tsd-signature tsd-kind-icon">handler<span class="tsd-signature-symbol">:</span> <a href="../modules/seng_event_lib_eventtypings.html#eventhandlerforevent" class="tsd-signature-type">EventHandlerForEvent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TEvent</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/80b2a2c/src/lib/EventListenerData.ts#L19">lib/EventListenerData.ts:19</a></li>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/98d7e85/src/lib/EventListenerData.ts#L19">lib/EventListenerData.ts:19</a></li>
</ul>
</aside>
</section>
Expand All @@ -230,12 +230,12 @@ <h3>is<wbr>Removed</h3>
<div class="tsd-signature tsd-kind-icon">is<wbr>Removed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> =&nbsp;false</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/80b2a2c/src/lib/EventListenerData.ts#L27">lib/EventListenerData.ts:27</a></li>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/98d7e85/src/lib/EventListenerData.ts#L27">lib/EventListenerData.ts:27</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This property will be set to <em>true</em> by the <a href="seng_event.eventdispatcher.html">EventDispatcher</a> this listener is bound to when
<p>This property will be set to <code>true</code> by the <a href="seng_event.eventdispatcher.html">EventDispatcher</a> this listener is bound to when
the listener is removed. This is to make sure the handler is not called, even if the listener
is removed while dispatching the event.</p>
</div>
Expand All @@ -247,7 +247,7 @@ <h3>priority</h3>
<div class="tsd-signature tsd-kind-icon">priority<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/80b2a2c/src/lib/EventListenerData.ts#L21">lib/EventListenerData.ts:21</a></li>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/98d7e85/src/lib/EventListenerData.ts#L21">lib/EventListenerData.ts:21</a></li>
</ul>
</aside>
</section>
Expand All @@ -257,7 +257,7 @@ <h3>type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../modules/seng_event_lib_eventtypings.html#typesforevent" class="tsd-signature-type">TypesForEvent</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">TEvent</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/80b2a2c/src/lib/EventListenerData.ts#L18">lib/EventListenerData.ts:18</a></li>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/98d7e85/src/lib/EventListenerData.ts#L18">lib/EventListenerData.ts:18</a></li>
</ul>
</aside>
</section>
Expand All @@ -267,7 +267,7 @@ <h3>use<wbr>Capture</h3>
<div class="tsd-signature tsd-kind-icon">use<wbr>Capture<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/80b2a2c/src/lib/EventListenerData.ts#L20">lib/EventListenerData.ts:20</a></li>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/98d7e85/src/lib/EventListenerData.ts#L20">lib/EventListenerData.ts:20</a></li>
</ul>
</aside>
</section>
Expand All @@ -285,7 +285,7 @@ <h3>dispose</h3>
<aside class="tsd-sources">
<p>Overrides Disposable.dispose</p>
<ul>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/80b2a2c/src/lib/EventListenerData.ts#L56">lib/EventListenerData.ts:56</a></li>
<li>Defined in <a href="https://github.com/mediamonks/seng-event/blob/98d7e85/src/lib/EventListenerData.ts#L56">lib/EventListenerData.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -333,6 +333,9 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
<li class="current tsd-kind-external-module">
<a href="../modules/seng_event.html">seng-<wbr>event</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/seng_event_lib_baseevent.html">seng-<wbr>event/lib/<wbr>Base<wbr>Event</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/seng_event_lib_eventtypings.html">seng-<wbr>event/lib/<wbr>Event<wbr>Typings</a>
</li>
Expand All @@ -355,9 +358,6 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="seng_event.abstractevent.html" class="tsd-kind-icon">Abstract<wbr>Event</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="seng_event.baseevent.html" class="tsd-kind-icon">Base<wbr>Event</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="seng_event.eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
</li>
Expand Down Expand Up @@ -398,22 +398,10 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</
</ul>
<ul class="after-current">
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../modules/seng_event.html#calllisteners" class="tsd-kind-icon">call<wbr>Listeners</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../modules/seng_event.html#createeventtype" class="tsd-kind-icon">create<wbr>Event<wbr>Type</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../modules/seng_event.html#createisomorphiceventtype" class="tsd-kind-icon">create<wbr>Isomorphic<wbr>Event<wbr>Type</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="../modules/seng_event.html#getcalltree" class="tsd-kind-icon">get<wbr>Call<wbr>Tree</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module">
<a href="../modules/seng_event.html#getparents" class="tsd-kind-icon">get<wbr>Parents</a>
<a href="../modules/seng_event.html#createeventclass" class="tsd-kind-icon">create<wbr>Event<wbr>Class</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../modules/seng_event.html#removelistenersfrom" class="tsd-kind-icon">remove<wbr>Listeners<wbr>From</a>
<a href="../modules/seng_event.html#createisomorphiceventclass" class="tsd-kind-icon">create<wbr>Isomorphic<wbr>Event<wbr>Class</a>
</li>
</ul>
</nav>
Expand Down

0 comments on commit 0065c0e

Please sign in to comment.