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.
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758<!doctype html><html class="default no-js"><head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>Router | 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="../modules/_okikio_native.html">@okikio/native</a> </li> <li> <a href="_okikio_native.Router.html">Router</a> </li> </ul> <h1>Class Router</h1> </div> </div></header><div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Controls what happens when certain url paths match a set of criteria</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <a href="_okikio_native.Service.html" class="tsd-signature-type" data-tsd-kind="Class">Service</a> <ul class="tsd-hierarchy"> <li> <span class="target">Router</span> </li> </ul> </li> </ul> </section> <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>Constructors</h3> <ul class="tsd-index-list"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"><a href="_okikio_native.Router.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#app" class="tsd-kind-icon">app</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#config" class="tsd-kind-icon">config</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#emitter" class="tsd-kind-icon">emitter</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#key" class="tsd-kind-icon">key</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#manager" class="tsd-kind-icon">manager</a></li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><a href="_okikio_native.Router.html#routes" class="tsd-kind-icon">routes</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_okikio_native.Router.html#add" class="tsd-kind-icon">add</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#boot" class="tsd-kind-icon">boot</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#init" class="tsd-kind-icon">init</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_okikio_native.Router.html#initEvents" class="tsd-kind-icon">init<wbr>Events</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#install" class="tsd-kind-icon">install</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_okikio_native.Router.html#isPath" class="tsd-kind-icon">is<wbr>Path</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_okikio_native.Router.html#parse" class="tsd-kind-icon">parse</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_okikio_native.Router.html#parsePath" class="tsd-kind-icon">parse<wbr>Path</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#register" class="tsd-kind-icon">register</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_okikio_native.Router.html#route" class="tsd-kind-icon">route</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#stop" class="tsd-kind-icon">stop</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="_okikio_native.Router.html#stopEvents" class="tsd-kind-icon">stop<wbr>Events</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#uninstall" class="tsd-kind-icon">uninstall</a></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_okikio_native.Router.html#unregister" class="tsd-kind-icon">unregister</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Constructors</h2> <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">new <wbr>Router<span class="tsd-signature-symbol">(</span>routes<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_okikio_native.IRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">IRoute</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_okikio_native.Router.html" class="tsd-signature-type" data-tsd-kind="Class">Router</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Overrides <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#constructor">constructor</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/router.ts#L25">native/src/router.ts:25</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>routes: <a href="../interfaces/_okikio_native.IRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">IRoute</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_okikio_native.Router.html" class="tsd-signature-type" data-tsd-kind="Class">Router</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="app" class="tsd-anchor"></a> <h3>app</h3> <div class="tsd-signature tsd-kind-icon">app<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_okikio_native.IApp.html" class="tsd-signature-type" data-tsd-kind="Interface">IApp</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#app">app</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/manager.ts#L15">native/src/manager.ts:15</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The App the ManagerItem is attached to</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="config" class="tsd-anchor"></a> <h3>config</h3> <div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_okikio_native.ICONFIG.html" class="tsd-signature-type" data-tsd-kind="Interface">ICONFIG</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#config">config</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/manager.ts#L18">native/src/manager.ts:18</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The Config of the App the ManagerItem is attached to</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="emitter" class="tsd-anchor"></a> <h3>emitter</h3> <div class="tsd-signature tsd-kind-icon">emitter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">EventEmitter</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#emitter">emitter</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/manager.ts#L21">native/src/manager.ts:21</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The EventEmitter of the App the ManagerItem is attached to</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="key" class="tsd-anchor"></a> <h3>key</h3> <div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#key">key</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/manager.ts#L24">native/src/manager.ts:24</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The key to where ManagerItem is stored in an AdvancedManager</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a name="manager" class="tsd-anchor"></a> <h3>manager</h3> <div class="tsd-signature tsd-kind-icon">manager<span class="tsd-signature-symbol">:</span> <a href="../modules/_okikio_native.html#TypeAdvancedManager" class="tsd-signature-type" data-tsd-kind="Type alias">TypeAdvancedManager</a></div> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#manager">manager</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/manager.ts#L12">native/src/manager.ts:12</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The AdvancedManager the ManagerItem is attached to</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a name="routes" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagProtected">Protected</span> routes</h3> <div class="tsd-signature tsd-kind-icon">routes<span class="tsd-signature-symbol">:</span> <a href="_okikio_native.Manager.html" class="tsd-signature-type" data-tsd-kind="Class">Manager</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_okikio_native.IRouteToFrom.html" class="tsd-signature-type" data-tsd-kind="Interface">IRouteToFrom</a><span class="tsd-signature-symbol">, </span><a href="../modules/_okikio_native.html#TypeRouteMethod" class="tsd-signature-type" data-tsd-kind="Type alias">TypeRouteMethod</a><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/native/src/router.ts#L24">native/src/router.ts:24</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>List of routes</p> </div> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="add" class="tsd-anchor"></a> <h3>add</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">(</span>__namedParameters<span class="tsd-signature-symbol">: </span><a href="../interfaces/_okikio_native.IRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">IRoute</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_okikio_native.Router.html" class="tsd-signature-type" data-tsd-kind="Class">Router</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/native/src/router.ts#L34">native/src/router.ts:34</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Add a new route to watch for</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>__namedParameters: <a href="../interfaces/_okikio_native.IRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">IRoute</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_okikio_native.Router.html" class="tsd-signature-type" data-tsd-kind="Class">Router</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="boot" class="tsd-anchor"></a> <h3>boot</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">boot<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">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#boot">boot</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/service.ts#L11">native/src/service.ts:11</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called on start of Service</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">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="init" class="tsd-anchor"></a> <h3>init</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">init<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">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#init">init</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/service.ts#L7">native/src/service.ts:7</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Called before the start of a Service, represents a constructor of sorts</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">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="initEvents" class="tsd-anchor"></a> <h3>init<wbr>Events</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">init<wbr>Events<span class="tsd-signature-symbol">(</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"> <aside class="tsd-sources"> <p>Overrides <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#initEvents">initEvents</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/router.ts#L135">native/src/router.ts:135</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Add listeners for PJAX Events</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="install" class="tsd-anchor"></a> <h3>install</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">install<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#install">install</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/manager.ts#L29">native/src/manager.ts:29</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Run after the Manager Item has been registered</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="isPath" class="tsd-anchor"></a> <h3>is<wbr>Path</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">is<wbr>Path<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../modules/_okikio_native.html#TypeRouteStyle" class="tsd-signature-type" data-tsd-kind="Type alias">TypeRouteStyle</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></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/native/src/router.ts#L55">native/src/router.ts:55</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Determines if a strings counts has a path</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>input: <a href="../modules/_okikio_native.html#TypeRouteStyle" class="tsd-signature-type" data-tsd-kind="Type alias">TypeRouteStyle</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="parse" class="tsd-anchor"></a> <h3>parse</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">parse<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../modules/_okikio_native.html#TypeRoutePath" class="tsd-signature-type" data-tsd-kind="Type alias">TypeRoutePath</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_okikio_native.IRouteToFrom.html" class="tsd-signature-type" data-tsd-kind="Interface">IRouteToFrom</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/native/src/router.ts#L65">native/src/router.ts:65</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Parse the multiple different formats for paths, into a { from, to } object</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>input: <a href="../modules/_okikio_native.html#TypeRoutePath" class="tsd-signature-type" data-tsd-kind="Type alias">TypeRoutePath</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="../interfaces/_okikio_native.IRouteToFrom.html" class="tsd-signature-type" data-tsd-kind="Interface">IRouteToFrom</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="parsePath" class="tsd-anchor"></a> <h3>parse<wbr>Path</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">parse<wbr>Path<span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><a href="../modules/_okikio_native.html#TypeRouteStyle" class="tsd-signature-type" data-tsd-kind="Type alias">TypeRouteStyle</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></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/native/src/router.ts#L41">native/src/router.ts:41</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Convert strings into path match functions</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>path: <a href="../modules/_okikio_native.html#TypeRouteStyle" class="tsd-signature-type" data-tsd-kind="Type alias">TypeRouteStyle</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">RegExp</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="register" class="tsd-anchor"></a> <h3>register</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</span>manager<span class="tsd-signature-symbol">: </span><a href="../modules/_okikio_native.html#TypeAdvancedManager" class="tsd-signature-type" data-tsd-kind="Type alias">TypeAdvancedManager</a>, key<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><a href="_okikio_native.ManagerItem.html" class="tsd-signature-type" data-tsd-kind="Class">ManagerItem</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#register">register</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/manager.ts#L32">native/src/manager.ts:32</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Register the current Manager Item's manager</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>manager: <a href="../modules/_okikio_native.html#TypeAdvancedManager" class="tsd-signature-type" data-tsd-kind="Type alias">TypeAdvancedManager</a></h5> </li> <li> <h5>key: <span class="tsd-signature-type">any</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_okikio_native.ManagerItem.html" class="tsd-signature-type" data-tsd-kind="Class">ManagerItem</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="route" class="tsd-anchor"></a> <h3>route</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">route<span class="tsd-signature-symbol">(</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"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/router.ts#L90">native/src/router.ts:90</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Test if route paths are true, if so run their methods</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="stop" class="tsd-anchor"></a> <h3>stop</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">stop<span class="tsd-signature-symbol">(</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"> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#stop">stop</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/service.ts#L23">native/src/service.ts:23</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Stop Service</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a name="stopEvents" class="tsd-anchor"></a> <h3>stop<wbr>Events</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <li class="tsd-signature tsd-kind-icon">stop<wbr>Events<span class="tsd-signature-symbol">(</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"> <aside class="tsd-sources"> <p>Overrides <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#stopEvents">stopEvents</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/router.ts#L141">native/src/router.ts:141</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Remove listeners for PJAX Events</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="uninstall" class="tsd-anchor"></a> <h3>uninstall</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">uninstall<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#uninstall">uninstall</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/manager.ts#L43">native/src/manager.ts:43</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Run before the ManagerItem has been unregistered</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a name="unregister" class="tsd-anchor"></a> <h3>unregister</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <li class="tsd-signature tsd-kind-icon">unregister<span class="tsd-signature-symbol">(</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"> <aside class="tsd-sources"> <p>Inherited from <a href="_okikio_native.Service.html">Service</a>.<a href="_okikio_native.Service.html#unregister">unregister</a></p> <ul> <li>Defined in <a href="https://github.com/okikio/native/blob/65f4e63/packages/native/src/manager.ts#L46">native/src/manager.ts:46</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Basically removes a ManagerItem, in order to recover the ManagerItem, it needs to be re-added to an AdvancedManager</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></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="../modules/_okikio_animate.html">@okikio/animate</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_okikio_emitter.html">@okikio/emitter</a> </li> <li class=" tsd-kind-module"> <a href="../modules/_okikio_manager.html">@okikio/manager</a> </li> <li class="current tsd-kind-module"> <a href="../modules/_okikio_native.html">@okikio/native</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-module"> <a href="_okikio_native.Router.html" class="tsd-kind-icon">Router</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite"> <a href="_okikio_native.Router.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#app" class="tsd-kind-icon">app</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#config" class="tsd-kind-icon">config</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#emitter" class="tsd-kind-icon">emitter</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#key" class="tsd-kind-icon">key</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#manager" class="tsd-kind-icon">manager</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-protected"> <a href="_okikio_native.Router.html#routes" class="tsd-kind-icon">routes</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_okikio_native.Router.html#add" class="tsd-kind-icon">add</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#boot" class="tsd-kind-icon">boot</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#init" class="tsd-kind-icon">init</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a href="_okikio_native.Router.html#initEvents" class="tsd-kind-icon">init<wbr>Events</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#install" class="tsd-kind-icon">install</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_okikio_native.Router.html#isPath" class="tsd-kind-icon">is<wbr>Path</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_okikio_native.Router.html#parse" class="tsd-kind-icon">parse</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_okikio_native.Router.html#parsePath" class="tsd-kind-icon">parse<wbr>Path</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#register" class="tsd-kind-icon">register</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_okikio_native.Router.html#route" class="tsd-kind-icon">route</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#stop" class="tsd-kind-icon">stop</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"> <a href="_okikio_native.Router.html#stopEvents" class="tsd-kind-icon">stop<wbr>Events</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#uninstall" class="tsd-kind-icon">uninstall</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited"> <a href="_okikio_native.Router.html#unregister" class="tsd-kind-icon">unregister</a> </li> </ul> </li> </ul> <ul class="after-current"> </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-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> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <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-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</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>