Something went wrong. Try again.
[READ-ONLY] Mirror of https://github.com/okikio/native. An initiative which aims to make it easy to create complex, light-weight, and perfor okikio.github.io/native
Something went wrong. Try again.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274<!doctype html><html class="default no-js"><head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>@okikio/emitter | The Native Initiative</title> <meta name="description" content="Documentation for The Native Initiative"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <script async src="../assets/js/search.js" id="search-script"></script></head><body><header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="../index.html" class="title">The Native Initiative</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../modules.html">The Native Initiative</a> </li> <li> <a href="_okikio_emitter.html">@okikio/emitter</a> </li> </ul> <h1>Module @okikio/emitter</h1> </div> </div></header><div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>References</h3> <ul class="tsd-index-list"> <li class="tsd-kind-reference tsd-parent-kind-module"><a href="_okikio_emitter.html#default" class="tsd-kind-icon">default</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_okikio_emitter.Event.html" class="tsd-kind-icon">Event</a></li> <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_okikio_emitter.EventEmitter.html" class="tsd-kind-icon">Event<wbr>Emitter</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_okikio_emitter.IListener.html" class="tsd-kind-icon">IListener</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_okikio_emitter.html#TypeEventInput" class="tsd-kind-icon">Type<wbr>Event<wbr>Input</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-module"><a href="_okikio_emitter.html#TypeListenerCallback" class="tsd-kind-icon">Type<wbr>Listener<wbr>Callback</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-module"><a href="_okikio_emitter.html#newListener" class="tsd-kind-icon">new<wbr>Listener</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>References</h2> <section class="tsd-panel tsd-member tsd-kind-reference tsd-parent-kind-module"> <a name="default" class="tsd-anchor"></a> <h3>default</h3> Renames and exports <a href="../classes/_okikio_emitter.EventEmitter.html">EventEmitter</a> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="TypeEventInput" class="tsd-anchor"></a> <h3>Type<wbr>Event<wbr>Input</h3> <div class="tsd-signature tsd-kind-icon">Type<wbr>Event<wbr>Input<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/emitter/src/api.ts#L37">emitter/src/api.ts:37</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The types of values <code>EventEmitter.prototype.on(...), EventEmitter.prototype.once(...), and EventEmitter.prototype.off(...)</code> accept</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module"> <a name="TypeListenerCallback" class="tsd-anchor"></a> <h3>Type<wbr>Listener<wbr>Callback</h3> <div class="tsd-signature tsd-kind-icon">Type<wbr>Listener<wbr>Callback<span class="tsd-signature-symbol">:</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">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/emitter/src/api.ts#L6">emitter/src/api.ts:6</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-signature"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Represents a listener callback function</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>args: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </li> </ul> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module"> <a name="newListener" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagConst">Const</span> new<wbr>Listener</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module"> <li class="tsd-signature tsd-kind-icon">new<wbr>Listener<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/_okikio_emitter.IListener.html" class="tsd-signature-type" data-tsd-kind="Interface">IListener</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_okikio_emitter.IListener.html" class="tsd-signature-type" data-tsd-kind="Interface">IListener</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/emitter/src/api.ts#L18">emitter/src/api.ts:18</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Creates a new listener based on <a href="../interfaces/_okikio_emitter.IListener.html">IListener</a></p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <a href="../interfaces/_okikio_emitter.IListener.html" class="tsd-signature-type" data-tsd-kind="Interface">IListener</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_okikio_emitter.IListener.html" class="tsd-signature-type" data-tsd-kind="Interface">IListener</a></h4> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class=" "> <a href="../modules.html">Modules</a> </li> <li class=" tsd-kind-module"> <a href="_okikio_animate.html">@okikio/animate</a> </li> <li class="current tsd-kind-module"> <a href="_okikio_emitter.html">@okikio/emitter</a> </li> <li class=" tsd-kind-module"> <a href="_okikio_manager.html">@okikio/manager</a> </li> <li class=" tsd-kind-module"> <a href="_okikio_native.html">@okikio/native</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-reference tsd-parent-kind-module"> <a href="_okikio_emitter.html#default" class="tsd-kind-icon">default</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/_okikio_emitter.Event.html" class="tsd-kind-icon">Event</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="../classes/_okikio_emitter.EventEmitter.html" class="tsd-kind-icon">Event<wbr>Emitter</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/_okikio_emitter.IListener.html" class="tsd-kind-icon">IListener</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="_okikio_emitter.html#TypeEventInput" class="tsd-kind-icon">Type<wbr>Event<wbr>Input</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="_okikio_emitter.html#TypeListenerCallback" class="tsd-kind-icon">Type<wbr>Listener<wbr>Callback</a> </li> <li class=" tsd-kind-function tsd-parent-kind-module"> <a href="_okikio_emitter.html#newListener" class="tsd-kind-icon">new<wbr>Listener</a> </li> </ul> </nav> </div> </div></div><footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> </ul> </div> </div></footer><div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/js/main.js"></script></body></html>