json-routing

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>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"> All <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> </ul> <h1> json-routing</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <h1 id="json-routes">JSON Routes</h1> <a href="https://travis-ci.org/gimox/json-routing"><img src="https://travis-ci.org/gimox/json-routing.svg?branch=2.0" alt="Build Status"></a> <a href="https://badge.fury.io/js/json-routing"><img src="https://badge.fury.io/js/json-routing.svg" alt="npm version"></a> <a href="https://coveralls.io/github/gimox/json-routing?branch=2.0"><img src="https://coveralls.io/repos/github/gimox/json-routing/badge.svg?branch=2.0" alt="Coverage Status"></a> Look at branch <a href="https://github.com/gimox/json-routing/tree/1.x">v1.x</a> for older release. <ul> <li>Typescript code, more optimized</li> <li>more speed</li> <li>remove some unused option</li> <li>make code more extensible and simple</li> <li>add automatic JWT route protection with auth0/express-jwt</li> <li>add route validator with express-validator</li> <li>prepare it for something more...... </li> </ul> <h2 id="make-me-the-code">MAKE ME THE CODE</h2> <h4 id="1-init-module">1 init module</h4> Typescript <pre><code class="lang-javascript">import {JsonRoute} from "json-route"; let routeInfo:Array<any> = new JsonRoute(app, { "routesPath": "./api/routes", "processdir": __dirname }).start(); </code></pre> JS ES6 <pre><code class="lang-javascript">let jsonRoute = require("json-route") let routeInfo = new JsonRoute(app, { "routesPath": "./api/routes", "processdir": __dirname }).start(); </code></pre> <h4 id="2-create-routes">2 create routes</h4> Create a route file definition <pre><code class="lang-json">{ "/admin": { "GET": { "route": "action", "policy": [ "test:check", "test:all", "./subfolder/test2:index" ] }, "POST": { "route": "action", "policy": [ "test:all", ] } }, "/dashboard": { "GET": { "route": "dashboard", } } } </code></pre> Routig with pure regular expression, add prefix "RE " before uri: <pre><code class="lang-json">{ "RE /.*fly$/": { "GET": { "route": "index" } } } </code></pre> <h2 id="what-is-it-">WHAT IS IT?</h2> Make routes much easier to use in MVC format. I've been searching for a while for a nodejs routing solution with a: <ul> <li>simple configuration,</li> <li>super performance,</li> <li>simple code,</li> <li>MVC organization,</li> <li>manage only routing, no other auto magic api creation</li> <li>customizable</li> <li>least possible dependency</li> </ul> This is: json-routes. <h2 id="how-it-works">How It Works</h2> The basic concepts. Create a json file with your routing config and add code logic in a external file called controller , creating an MVC style structure. I followed the Expressjs 4 routing standards, helping the developer to manage the routes creation and project organization faster and in the standard synthax. Look at <a href="http://expressjs.com/en/guide/routing.html">express routing guide</a> for a complet route pattern syntax <h2 id="proposed-structure">Proposed Structure</h2> This is an example of the default proposed structure, you can customize and change as you prefer. <pre><code>project root ├── controllers/ │ ├── IndexController.js │ ├── AuthController.js │ ├── UsersController.js ├── policy/ │ │ ├── AuthorizationPolicy.js │ │ ├── mymiddleware.js ├── routes/ │ │ │ ├── auth.json │ │ │ ├── users.json │ │ │ ├── index.json ├── app.js/ ├── package.json/ ├── README.md/ </code></pre><ul> <li>Controller: contains the code's logic</li> <li>Policy: contains the function called before the controller = middleware</li> <li>Routes: contains all the <code>*.json</code> routing configuration. You can create as many *.json files as you need. By default, all routes within a file look up the corresponding controller (= modules = controllers = middleware) inside the controller's default directory <code>./controller</code> (or within the directory specified by the user), which uses the following naming format: Route-name (without .json) + "Controller.js (the first letter must be capitalized)".</li> </ul> <blockquote> EXAMPLE: If you have a definition file called <code>users.json</code>, by default the route searches the controller <code>UsersControllers.js</code>. For routes auth.json all routes call the controller <code>AuthController.js</code> ecc.. ecc.. NOTE: this is a proposed structure but you can configure the module for your structure, you can change dir structure or add all routes in a single file. </blockquote> <h3 id="creating-json-configuration-file">Creating JSON Configuration file</h3> The routing file is encoded in the JSON format and by default is in <code>./routes.</code> Router is created using this syntax: <code>{ "RoutePath" : {"verb": {options} } }</code> Example of extended config <pre><code class="lang-javascript">{ "routePath": { "VERB": { "route": "controller:method", "policy": [ "controller:method", ] } }, "/admin": { "GET": { "route": "action", "policy": [ "./demo/policycustom/test:check", "test:all", "./subfolder/test2:index" ] }, "POST": { "route": "./mycustomfolder/controllername:index", "policy": [ "./demo/policycustom/test:check", "test:all", "./subfolder/test2:index" ] } }, ... more routes } </code></pre> <h3 id="routepath">RoutePath</h3> This is the routing path and it follows the express4 standard routing. You can use jolly character and other type syntax <code>/admin*,</code> <code>/admin/:name</code> etc. etc.; <h3 id="verb">Verb</h3> Relates to the call verb and can assume any valid http verbs like GET, POST, PUT, DELETE etc etc. You can add more verbs for a single routePath: <pre><code class="lang-javascript">{ "/admin": { "GET": { "route": "action", "policy": [ "./demo/policycustom/test:check", "test:all", "./subfolder/test2:index" ] }, "POST": { "route": "action", "policy": [ "test:all", ] } } </code></pre> <code>/admin</code> has GET and POST verbs. <h3 id="route">Route</h3> Relates to <code>file:method</code> to call a route address. By default, the routing search controller file inside the default controller directory is: <code>./controlles</code>, and you can change it using the global options explained in this document. If the controller is not set, the routing will search a file called with the same name as the json file, with "Controller" as suffix. <blockquote> Example: If you have a definition file called <code>users.json</code>, by default the route searches the controller <code>UsersControllers.json</code>. For routes auth.json all routes call the controller <code>AuthController.js</code> etc.. etc.. </blockquote> Summarize route params If you omit the route params, the system routing assumes you have a default route controller path/name and a method called "index". If you add only a parameter, it assumes that the controller is in the default directory with standard name <code>nameController.js</code> , and the parameter is the method that should be called. example route: "testall" If the route params contain both values <code>./path/controllername:method</code> (user:index) it will search the controller using the default directory path structured as controller name followed by method. For example, route: "./test/user:index" searches for a controller called ./test/user with method index. If you need to call a controller in a subfolder, simply add the path before the controller name. Example route: "./afolder/user:index", fire ./controller/afolder/user with method index. If you need to call a controller starting to your project root simply add <code>.</code> before the path. Example route: "./lib/user:index", fire ./lib/user.js with method index. <h3 id="policy">Policy</h3> Is a module/function called before the controller (= middleware), by default it calls a file in ./policy named as you set in parameters "fileName" and a function named as you set in "functionName". Example: policy: "auth/index" calls ./policy/auth.js and method index The syntax is the same as <code>route</code> params It can be a string for a single policy or an array for multiple policy files. <h3 id="cors">CORS</h3> Enable or disable Cross-origin resource sharing. default is true, look at global options for more info. <h3 id="regex">Regex</h3> You can set a regex to validate your route, however I discourage using it. Instead, I prefer to add this logic in the controller for better code speed. To set a rexeg route, use the prefix "RE " before pattern.. <pre><code class="lang-javascript">{ "RE /.*fly$/": { "GET": { "route": "action", "policy": [ "./demo/policycustom/test:check", "test:all", "./subfolder/test2:index" ] } } </code></pre> <h3 id="init-module">Init Module</h3> Configure the routing modules in your main js file, as any other nodes modules. <pre><code class="lang-javascript">var routes = require('json-routing'); new routes(expressApp, options).start(); </code></pre> Example: <pre><code class="lang-javascript">// Includes var express = require('express'); var app = express(); var routes = require('json-routing'); // add module ... // your code.. app.set(...); app.use(...); // this is the magic! new routes(app, { "processdir": __dirname }).start(); </code></pre> IT'S VERY IMPORTANT TO SET <code>processdir": __dirname</code> if your project is in a subfolder of root. (example ./src/) <h2 id="change-default-options">Change default Options</h2> When you initialize the module, you can specify a few options to customize the directory structure. All are listed below with the default values. An explanation follows. your main.js file. <pre><code class="lang-javascript">// Includes var express = require('express'); var app = express(); var routes = require('json-routing'); // add module // your code.. app.set(...); app.use(...); //define routes default options var routeOptions = { routesPath : "./api/routes", controllerPath : "./api/controllers", policyPath : "./api/policy", cors : true, displayRoute : true, defaultAction : "index", processDir : process.cwd() } //init routes var routeInfo = new routes(app, routeOptions); </code></pre> <ul> <li>routesPath : the path to your routes folder. <code>Default ./routes</code></li> <li>controllerPath : the path to your controller folder. <code>Default ./controllers</code></li> <li>policyPath : the path to your policy folder. <code>Default ./policy</code></li> <li>cors : enable cross origin resource sharing for all routes. (more cors options coming soon..). <code>Default false</code></li> <li>displayRoute : display in console loading route info, <code>default true</code>.</li> <li>defaultAction : the function called in route if not specified. It's not so useful, but it's here!.<code>Default index</code></li> <li>processDir : The root base path of the project, default <code>process.cwd()</code> set as <code>__dirname</code> if you need to start in a subfolder or complex project.</li> </ul> If you omit routeOptions or some params it use defaults values. <h2 id="change-json-file-global-options">Change json file Global Options</h2> If you need to change options for all routes only for a specific *.json file, you can set in your file the key <code>GLOBAL</code> as in the following example: user.json <pre><code class="lang-javascript">{ "GLOBAL": { "controller": "./customdir/customControllerName", "policy":["config:setall","config:connection"], "baseUrl":"/user" }, "/create": { "PUT": { "route": "index", "policy": [ "auth:check", "auth:adduserparams" ] } } } </code></pre> Example: route controller is ./customdir/UserController.js <ul> <li>controller: set a custom controller path for all routing file</li> <li>policy: is an array of policy <code>file:action</code> to fire before controller</li> <li>baseUrl: is a base path for all url routes in file. Example, inside a file all routes start with <code>/api/*</code>, i can set base url as <code>/api</code>. Now all file routes start with <code>/api</code>. If i have a routes <code>/users</code>, it fired when user called <code>/api/users</code></li> </ul> <blockquote> NOTE: the key "GLOBAL" must be uppercase. </blockquote> <h2 id="full-extended-example">Full extended example</h2> app.js <pre><code class="lang-javascript">var express = require('express') , app = express() , port = process.env.PORT || 3000 , routing = require('./lib/route'); /** * global options for routing * * set all file inside /api/* for a more cleaner code */ var routeOptions = { routesPath: "./api/routes" , controllersPath: "./api/controllers" , policyPath: './api/policy' , cors: false , processDir: __dirname }; /** * init json-routing */ new routing(app, routeOptions); /** * standard express 4 routing * yes.. you can use both routing together if you need */ var router = express.Router(); router.get('/express/', function (req, res) { res.send(' this is a standard routing '); }); app.use('/', router); /** * server start * * @type {http.Server} */ var server = app.listen(port, function () { console.log('Listening on port %d', server.address().port); }); </code></pre> This is the main file, we set routing and add global setting to use ./api as root directory ./api/routes/users.json <pre><code class="lang-javascript">{ "/banned": { "GET": { "route": "./lib/bannedCustom:index", } }, "/user": { "GET": { "route": "find", "policy": [ "auth:check", "auth:adduserparams" ] }, "PUT": { "route": "create", "policy": [ "auth:check", ] } } } </code></pre> define the routes ./api/controllers/UsersController.js <pre><code class="lang-javascript">exports.index = function(req,res,next) { res.send(' index routes '); }; exports.create = function(req,res,next) { res.send(' create routes params:'+req.params.name); }; </code></pre> a basic controller logic ./api/controllers/bannedCustom.js <pre><code class="lang-javascript">exports.getbanned = function(req,res,next) { res.send(' custom controller name '); }; </code></pre> this is the controller with custom name ./api/policy/auth.js <pre><code class="lang-javascript">exports.check = function(req,res,next) { if (!req.session.isLogged){ return res.redirect('http://'+req.hostname+":3000/403"); } next(); }; </code></pre> Let me explain this policy: it checks if a user is logged, else set a redirect, so we can use the middleware to check ACL, authorization or get/set global vars, and this is very useful. <h2 id="create-a-policy-file-and-pass-vars-to-controller">Create a Policy File and Pass vars to controller</h2> We encourage to use standard tecnique for best performance: use middleware. using the full example described below we can create a standard policy file to attach a global var using <code>req</code> ./api/policy/auth.js <pre><code class="lang-javascript">exports.getbanned = function(req,res,next) { if (!req.session.isLogged){ return res.redirect('http://'+req.hostname+":3000/403"); } //use req req.session.lastPing = new Date(); next(); }; </code></pre> Read the value in the controller or policy ./api/controllers/bannedCustom.js <pre><code class="lang-javascript">exports.getbanned = function(req,res,next) { res.send(' custom controller name, middleware loaded at: '+req.session.lastPing); }; </code></pre> <h2 id="case-using-middleware">Case: using middleware</h2> A special case: if we want to add an authentication before some route, take a look at this example: <pre><code class="lang-javascript">{ "/admin*": { "GET": { "route": "./policy/auth:check", }, "POST": { "route": "auth:check", }, "PUT": { "route": "auth:check", }, "DELETE": { "route": "auth:check", }, }, "/admin/dashboard": { "GET": { "route": "getItem", } }, "/admin/user": { "GET": { "route": "find", }, "PUT": { "route": "create", } } }} </code></pre> All <code>admin*</code> route calls the controller <code>auth</code>, so now <code>auth:check</code> is executed before all <code>admin*</code> controller and it becomes a policy (=middleware) and for a clear structure i put the file in policy dir. An alternative example use the global file option: <pre><code class="lang-javascript">{ "GLOBAL": { "policy":["auth:check"], "baseUrl":"/admin" }, "/dashboard": { "GET": { "route": "getItem", } }, "/user": { "GET": { "route": "find", }, "PUT": { "route": "create", } } }} </code></pre> <h2 id="protected-route-with-jwt">Protected route with JWT</h2> You can protect a routes using <a href="https://jwt.io/">jwt</a>. Json-routing use <a href="https://github.com/auth0/express-jwt">auth0/express-jwt</a>. To protect a route add a property <code>jwt:true</code> and set the global options for jwt as example. Before using jwt you need to install express-jwt manually: <code>npm install --save express-jwt</code> Route file: protected.json <pre><code>{ "/protected": { "GET": { "route": "index", "jwt": true } }, "/notprotected": { "GET": { "route": "indexnot", "jwt": false } } } </code></pre>NB note to pretect a route we need to set <code>jwt:true</code> In main file: server.ts/js <pre><code>... export const routeInfo: Array<IRouteInfo> = new JsonRoute(app, { "processdir": __dirname, "jwt": { "secret": "12345678910abc" } }).start(); ... </code></pre>NB in json-routing init we need to set jwt object with secret DONE!!!!! <h3 id="jwt-extra-route-for-error">jwt extra route for error</h3> to make a better jwt unauthorized response we can add a specific route like this: <pre><code>export const routeInfo: Array<IRouteInfo> = new JsonRoute(app, { "processdir": __dirname, "jwt": { "secret": "12345678910abc" } }).start(); app.use((err: any, req: express.Request, res: express.Response, next: express.NextFunction) => { if (err.name === 'UnauthorizedError') { res.status(401).json({"message": "invalid token..."}); } next(); }); </code></pre><h2 id="add-a-global-route-prefix">Add a global route prefix</h2> You can add a global prefix path for all routes set options.urlPrefix <pre><code>export const routeInfo: Array<IRouteInfo> = new JsonRoute(app, { "processdir": __dirname, "urlPrefix":"/api/v1" }).start(); </code></pre>All routes now start with <code>/api/vi</code> <h2 id="route-validation-params">Route validation params</h2> It can be done by express-validator using schema. Add <code>validators</code> object with: <ul> <li>params -> route params es /home/:id</li> <li>query -> query params es -> /home?id=124</li> <li>boby -> body params es post params like {"id":"1233"}</li> </ul> according <a href="https://github.com/ctavan/express-validator">express-validator</a> "validation by Schema" route file.json <pre><code>{ "/validateparam/:id": { "GET": { "route": "validateparam", "jwt": false, "validators": { "params": { "id": { "notEmpty": true, "isLength": { "options": [ { "min": 5, "max": 10 } ], "errorMessage": "Must be between 2 and 10 chars long" }, "errorMessage": "id is required" } } } } } } </code></pre>NB body-parser middleware is injected by json-routing, you can pass params in global params <h2 id="all-options">ALL OPTIONS</h2> <pre><code class="lang-javascript">export interface IOptions { routesPath?: string , controllersPath?: string , policyPath?: string , processdir?: string , cors?: boolean , displayRoute?: boolean , defaultAction?: string , urlPrefix?: string , jwt?: { secret: any } , bodyParserUrlEncoded?: any } ... let options: IOptions; ... // add params to optins object let routeInfo:Array<any> = new JsonRoute(app, options}).start(); </code></pre> <h2 id="example">Example</h2> Look at ./demo for a fully working example. <h2 id="changelog-2-0-5">Changelog 2.0.5</h2> <ul> <li>better cors support</li> <li>can be enable/disable cors for single routes</li> <li>better console output</li> </ul> <h2 id="changelog-2-0-4">Changelog 2.0.4</h2> <ul> <li>add validator</li> </ul> <h2 id="changelog-2-0-1">Changelog 2.0.1</h2> <ul> <li>add protected route with JWT</li> </ul> <h2 id="changelog-2-0-0">Changelog 2.0.0</h2> <ul> <li>add urlPrefix for all routes</li> </ul> <h2 id="changelog-2-0-0rc1">Changelog 2.0.0Rc1</h2> <ul> <li>minor fix</li> <li>route with regular expression</li> </ul> <h2 id="changelog-2-0-0b1">Changelog 2.0.0b1</h2> <ul> <li>completely rewrite in typecript (build transpiled in es6)</li> <li>remove global policy options </li> <li>global now has "controller" option</li> <li>make more simple</li> <li>regex now work good!</li> <li>more speed</li> <li>add test and coverage</li> </ul> <h2 id="changelog-0-1-5">Changelog 0.1.5</h2> <ul> <li>Preparing for typescript... es6 and node > 6.4 rewrite, removed underscore. No esternal modules deps!!</li> </ul> <h2 id="changelog-0-1-0">Changelog 0.1.0</h2> <ul> <li>minor fix</li> </ul> <h2 id="changelog-0-1-0">Changelog 0.1.0</h2> <ul> <li>removed not working cors features for file definition and route... working on it.. cors for global setting work good.</li> </ul> <h2 id="changelog-0-0-27">Changelog 0.0.27</h2> <ul> <li>improve log info</li> </ul> <h2 id="changelog-0-0-26">Changelog 0.0.26</h2> <ul> <li>add <code>defaultAction</code>, not so useful, but it's here!.</li> <li>start cleaning code</li> <li>add <code>CORS</code> Global file options, to enable CORS only in specific *.json routes</li> <li>add <code>CORS</code> for specific routes.</li> <li>route log info display CORS status</li> </ul> <h2 id="changelog-0-0-25">Changelog 0.0.25</h2> <ul> <li>improve route info on load, it can disabled with global options "displayRoute:false"</li> </ul> <h2 id="changelog-0-0-24">Changelog 0.0.24</h2> <ul> <li>initial CORS support (look at "Change default Options"), more CORS options coming soon...</li> </ul> <h2 id="changelog-0-23">Changelog 0.23</h2> <ul> <li>fix url union for windows platform</li> </ul> <h2 id="changelog-0-0-20">Changelog 0.0.20</h2> <ul> <li>fix policy string is not added if global policy is set</li> <li>working test</li> </ul> <h2 id="changelog-0-0-19">Changelog 0.0.19</h2> <ul> <li>add Global base Url</li> </ul> <h2 id="changelog-0-0-17">Changelog 0.0.17</h2> <ul> <li>fix default route</li> <li>add mre error check</li> </ul> <h2 id="changelog-0-0-15">Changelog 0.0.15</h2> <ul> <li>add goblal file policy (=middleware)</li> </ul> <h2 id="changelog-from-version-0-0-13">Changelog from version 0.0.13</h2> <ul> <li>No longer compatible with <0.13 version</li> <li>new json syntax</li> </ul> </div> </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">Globals</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_interfaces_icontrollerglobal_.html">"interfaces/IControllerGlobal"</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/IJsonRoute"</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/IRouteInfo"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_jroute_handler_.html">"jroute-handler"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_json_route_.html">"json-route"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_route_controller_.html">"route-controller"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_route_middleware_.html">"route-middleware"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_route_validator_.html">"route-validator"</a> </li> <li class=" tsd-kind-external-module"> <a href="modules/_routes_display_.html">"routes-display"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-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">Module</li> <li class="tsd-kind-object-literal">Object literal</li> <li class="tsd-kind-variable">Variable</li> <li class="tsd-kind-function">Function</li> <li class="tsd-kind-function tsd-has-type-parameter">Function with type parameter</li> <li class="tsd-kind-index-signature">Index signature</li> <li class="tsd-kind-type-alias">Type alias</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum">Enumeration</li> <li class="tsd-kind-enum-member">Enumeration member</li> <li class="tsd-kind-property tsd-parent-kind-enum">Property</li> <li class="tsd-kind-method tsd-parent-kind-enum">Method</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface">Interface</li> <li class="tsd-kind-interface tsd-has-type-parameter">Interface with type parameter</li> <li class="tsd-kind-constructor tsd-parent-kind-interface">Constructor</li> <li class="tsd-kind-property tsd-parent-kind-interface">Property</li> <li class="tsd-kind-method tsd-parent-kind-interface">Method</li> <li class="tsd-kind-index-signature tsd-parent-kind-interface">Index signature</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-class">Class</li> <li class="tsd-kind-class tsd-has-type-parameter">Class with type parameter</li> <li class="tsd-kind-constructor tsd-parent-kind-class">Constructor</li> <li class="tsd-kind-property tsd-parent-kind-class">Property</li> <li class="tsd-kind-method tsd-parent-kind-class">Method</li> <li class="tsd-kind-accessor tsd-parent-kind-class">Accessor</li> <li class="tsd-kind-index-signature tsd-parent-kind-class">Index signature</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">Inherited constructor</li> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited">Inherited property</li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited">Inherited method</li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited">Inherited accessor</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected">Protected property</li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected">Protected method</li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected">Protected accessor</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private">Private property</li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-private">Private method</li> <li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private">Private accessor</li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static">Static property</li> <li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static">Static method</li> </ul> </div> </div> </footer> <div class="container tsd-generator"> Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a> </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>