json-routing

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>JsonRoute | json-routing</title> <meta name="description" content=""> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> </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.js" 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">json-routing</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> <input type="checkbox" id="tsd-filter-only-exported" /> <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</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="../globals.html">Globals</a> </li> <li> <a href="../modules/_json_route_.html">"json-route"</a> </li> <li> <a href="_json_route_.jsonroute.html">JsonRoute</a> </li> </ul> <h1>Class JsonRoute</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>Main file Json-route create a express like route using a json definition file without extra code</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">JsonRoute</span> </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"><a href="_json_route_.jsonroute.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"><a href="_json_route_.jsonroute.html#app" class="tsd-kind-icon">app</a></li> <li class="tsd-kind-property tsd-parent-kind-class"><a href="_json_route_.jsonroute.html#options" class="tsd-kind-icon">options</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="_json_route_.jsonroute.html#displayinfo" class="tsd-kind-icon">displayinfo</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_json_route_.jsonroute.html#getjsonroute" class="tsd-kind-icon">get<wbr>Json<wbr>Route</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_json_route_.jsonroute.html#setcors" class="tsd-kind-icon">set<wbr>Cors</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_json_route_.jsonroute.html#setdefaultmdlw" class="tsd-kind-icon">set<wbr>Default<wbr>Mdlw</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_json_route_.jsonroute.html#start" class="tsd-kind-icon">start</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"> <a name="constructor" class="tsd-anchor"></a> <h3>constructor</h3> <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">new <wbr>Json<wbr>Route<span class="tsd-signature-symbol">(</span>app<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, options<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_ioptions_.ioptions.html" class="tsd-signature-type">IOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_json_route_.jsonroute.html" class="tsd-signature-type">JsonRoute</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gimox/json-routing/blob/3811a5e/src/json-route.ts#L20">json-route.ts:20</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>app: <span class="tsd-signature-type">any</span></h5> </li> <li> <h5>options: <a href="../interfaces/_interfaces_ioptions_.ioptions.html" class="tsd-signature-type">IOptions</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_json_route_.jsonroute.html" class="tsd-signature-type">JsonRoute</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"> <a name="app" class="tsd-anchor"></a> <h3>app</h3> <div class="tsd-signature tsd-kind-icon">app<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gimox/json-routing/blob/3811a5e/src/json-route.ts#L19">json-route.ts:19</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"> <a name="options" class="tsd-anchor"></a> <h3>options</h3> <div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_interfaces_ioptions_.ioptions.html" class="tsd-signature-type">IOptions</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gimox/json-routing/blob/3811a5e/src/json-route.ts#L20">json-route.ts:20</a></li> </ul> </aside> </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="displayinfo" class="tsd-anchor"></a> <h3>displayinfo</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">displayinfo<span class="tsd-signature-symbol">(</span>routesInfo<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_interfaces_irouteinfo_.irouteinfo.html" class="tsd-signature-type">IRouteInfo</a><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/gimox/json-routing/blob/3811a5e/src/json-route.ts#L97">json-route.ts:97</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Display routes info table at startup</p> </div> <dl class="tsd-comment-tags"> <dt>params</dt> <dd><p>{Array<IRouteInfo>} route info definition</p> </dd> </dl> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>routesInfo: <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_interfaces_irouteinfo_.irouteinfo.html" class="tsd-signature-type">IRouteInfo</a><span class="tsd-signature-symbol">></span></h5> </li> </ul> <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"> <a name="getjsonroute" class="tsd-anchor"></a> <h3>get<wbr>Json<wbr>Route</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Json<wbr>Route<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_interfaces_ijsonroute_.ijsonroute.html" class="tsd-signature-type">IJsonRoute</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gimox/json-routing/blob/3811a5e/src/json-route.ts#L69">json-route.ts:69</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Get a list of json routes definition file</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_interfaces_ijsonroute_.ijsonroute.html" class="tsd-signature-type">IJsonRoute</a><span class="tsd-signature-symbol">></span></h4> <ul> <li>json route path definition file</li> </ul> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="setcors" class="tsd-anchor"></a> <h3>set<wbr>Cors</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Cors<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/gimox/json-routing/blob/3811a5e/src/json-route.ts#L105">json-route.ts:105</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Enable cors for all routes</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"> <a name="setdefaultmdlw" class="tsd-anchor"></a> <h3>set<wbr>Default<wbr>Mdlw</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">set<wbr>Default<wbr>Mdlw<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/gimox/json-routing/blob/3811a5e/src/json-route.ts#L29">json-route.ts:29</a></li> </ul> </aside> <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"> <a name="start" class="tsd-anchor"></a> <h3>start</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">start<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_interfaces_irouteinfo_.irouteinfo.html" class="tsd-signature-type">IRouteInfo</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gimox/json-routing/blob/3811a5e/src/json-route.ts#L43">json-route.ts:43</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>This is the main fnc</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_interfaces_irouteinfo_.irouteinfo.html" class="tsd-signature-type">IRouteInfo</a><span class="tsd-signature-symbol">></span></h4> <ul> <li>a list of routes parsed</li> </ul> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Globals</em></a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_interfaces_icontrollerglobal_.html">"interfaces/IController<wbr>Global"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_interfaces_ihandler_.html">"interfaces/IHandler"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_interfaces_ijsonroute_.html">"interfaces/IJson<wbr>Route"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_interfaces_ioptions_.html">"interfaces/IOptions"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_interfaces_irouteinfo_.html">"interfaces/IRoute<wbr>Info"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_jroute_handler_.html">"jroute-<wbr>handler"</a> </li> <li class="current tsd-kind-external-module"> <a href="../modules/_json_route_.html">"json-<wbr>route"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_route_controller_.html">"route-<wbr>controller"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_route_middleware_.html">"route-<wbr>middleware"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_route_validator_.html">"route-<wbr>validator"</a> </li> <li class=" tsd-kind-external-module"> <a href="../modules/_routes_display_.html">"routes-<wbr>display"</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-external-module"> <a href="_json_route_.jsonroute.html" class="tsd-kind-icon">Json<wbr>Route</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="_json_route_.jsonroute.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_json_route_.jsonroute.html#app" class="tsd-kind-icon">app</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class"> <a href="_json_route_.jsonroute.html#options" class="tsd-kind-icon">options</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_json_route_.jsonroute.html#displayinfo" class="tsd-kind-icon">displayinfo</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_json_route_.jsonroute.html#getjsonroute" class="tsd-kind-icon">get<wbr>Json<wbr>Route</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_json_route_.jsonroute.html#setcors" class="tsd-kind-icon">set<wbr>Cors</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_json_route_.jsonroute.html#setdefaultmdlw" class="tsd-kind-icon">set<wbr>Default<wbr>Mdlw</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_json_route_.jsonroute.html#start" class="tsd-kind-icon">start</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-module"><span class="tsd-kind-icon">Module</span></li> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <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-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li> <li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</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-enum"><span class="tsd-kind-icon">Enumeration</span></li> <li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li> <li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</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> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li> <li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li> <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> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</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> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script> </body> </html>