<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: Router</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: Router</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>Router<span class="signature">()</span><span class="type-signature"></span></h2> <div class="class-description">A bare-bones history-api based SPA router.</div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="Router"><span class="type-signature"></span>new Router<span class="signature">()</span><span class="type-signature"></span></h4> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="module_routing.js.html">module/routing.js</a>, <a href="module_routing.js.html#line4">line 4</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="base_path"><span class="type-signature"></span>base_path<span class="type-signature"></span></h4> <div class="description"> Returns the APP_BASE_PATH of the application. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="module_routing.js.html">module/routing.js</a>, <a href="module_routing.js.html#line27">line 27</a> </li></ul></dd> </dl> <h4 class="name" id="history"><span class="type-signature"></span>history<span class="type-signature"></span></h4> <div class="description"> Array of router history records. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="module_routing.js.html">module/routing.js</a>, <a href="module_routing.js.html#line21">line 21</a> </li></ul></dd> </dl> <h4 class="name" id="route_args"><span class="type-signature"></span>route_args<span class="type-signature"> :undefined|*</span></h4> <div class="description"> Arguments for the current route. </div> <h5>Type:</h5> <ul> <li> <span class="param-type">undefined</span> | <span class="param-type">*</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="module_routing.js.html">module/routing.js</a>, <a href="module_routing.js.html#line9">line 9</a> </li></ul></dd> </dl> <h4 class="name" id="subscribers"><span class="type-signature"></span>subscribers<span class="type-signature"></span></h4> <div class="description"> List of callback functions listening for route changes. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="module_routing.js.html">module/routing.js</a>, <a href="module_routing.js.html#line15">line 15</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="back"><span class="type-signature"></span>back<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> Navigate back one route. </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="module_routing.js.html">module/routing.js</a>, <a href="module_routing.js.html#line46">line 46</a> </li></ul></dd> </dl> <h4 class="name" id="build_url"><span class="type-signature"></span>build_url<span class="signature">(…parts)</span><span class="type-signature"> → {string}</span></h4> <div class="description"> Given an array of route parts, build a joined URL route. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>parts</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <repeatable><br> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="module_routing.js.html">module/routing.js</a>, <a href="module_routing.js.html#line76">line 76</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id="navigate"><span class="type-signature"></span>navigate<span class="signature">(path, args)</span><span class="type-signature"></span></h4> <div class="description"> Navigate the app to the given path with the given args. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>path</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>args</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="module_routing.js.html">module/routing.js</a>, <a href="module_routing.js.html#line36">line 36</a> </li></ul></dd> </dl> <h4 class="name" id="subscribe"><span class="type-signature"></span>subscribe<span class="signature">(handler)</span><span class="type-signature"> → {object}</span></h4> <div class="description"> Subscribe to listen for route changes. Returns an object with an unsubscribe() property. </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>handler</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">callback called when the route changes</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="module_routing.js.html">module/routing.js</a>, <a href="module_routing.js.html#line59">line 59</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> - subscription manager </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-util.html">util</a></li></ul><h3>Classes</h3><ul><li><a href="AddPlayersComponent.html">AddPlayersComponent</a></li><li><a href="DraftBoardComponent.html">DraftBoardComponent</a></li><li><a href="GridActionButtonComponent.html">GridActionButtonComponent</a></li><li><a href="GridComponent.html">GridComponent</a></li><li><a href="LeagueComponent.html">LeagueComponent</a></li><li><a href="LinkComponent.html">LinkComponent</a></li><li><a href="MyTeamComponent.html">MyTeamComponent</a></li><li><a href="Router.html">Router</a></li><li><a href="ScoresComponent.html">ScoresComponent</a></li><li><a href="TopLevelComponent.html">TopLevelComponent</a></li></ul><h3>Global</h3><ul><li><a href="global.html#GridCellRenderType">GridCellRenderType</a></li><li><a href="global.html#router">router</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Sun Oct 25 2020 12:31:45 GMT-0500 (Central Daylight Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>