opennms
Version:
Client API for the OpenNMS network monitoring platform
485 lines • 24.7 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>OpenNMS.js</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">OpenNMS.js</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>
</ul>
<h1> OpenNMS.js</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="opennms-javascript-api-circleci">OpenNMS Javascript API <a href="https://circleci.com/gh/OpenNMS/opennms-js"><img src="https://circleci.com/gh/OpenNMS/opennms-js.svg?style=svg" alt="CircleCI"></a></h1>
<p>A client API for accessing the OpenNMS network monitoring platform.</p>
<h1 id="using-the-opennms-js-apis-in-your-code">Using the OpenNMS.js APIs In Your Code</h1>
<p>Information on getting started and how to use the API is in the <a href="https://github.com/OpenNMS/opennms-js/blob/master/HOWTO.md">HOWTO document</a>.</p>
<p>The complete API list is available at <a href="http://docs.opennms.org/opennms-js/branches/master/opennms-js/opennms-js.html">docs.opennms.org</a>.</p>
<h1 id="using-the-opennms-js-command-line">Using the OpenNMS.js Command Line</h1>
<ol>
<li>install <a href="https://nodejs.org/en/download/">Node.js</a></li>
<li>run <code>sudo npm install -g opennms</code></li>
<li>run <code>opennms --help</code> for a list of possible commands</li>
</ol>
<h1 id="api-coverage">API Coverage</h1>
<p>OpenNMS.js currently supports a subset of the OpenNMS ReST API:</p>
<ul>
<li>query alarms, events, and nodes (including complex queries against OpenNMS Horizon 21+ and Meridian 2017+)</li>
<li>acknowledge, escalate, and clear alarms</li>
<li>create, update, and close trouble tickets against an alarm</li>
<li>create, update, and delete alarm sticky memos</li>
<li>create, update, and delete alarm journal memos</li>
</ul>
<p>Future plans include adding support for other common ReST operations:</p>
<ul>
<li>creating, updating, deleting, and importing requisitions</li>
<li>query the measurements ReST API (RRD/Newts time-series data)</li>
<li>query outages and notifications</li>
</ul>
<h1 id="changes">Changes</h1>
<p>The CHANGELOG will be updated as releases occur, and should always be accessible <a href="https://github.com/OpenNMS/opennms-js/blob/master/CHANGELOG.md">here</a>.</p>
<h1 id="development">Development</h1>
<p>To build this project, first install yarn:</p>
<p><code>npm install -g yarn</code></p>
<p>Then run yarn to fetch all dependencies:</p>
<p><code>yarn</code></p>
<p>Then you can run yarn to build or test the project:</p>
<ul>
<li><code>yarn dist</code> - run tests and lint, and build the complete tree in <code>dist/</code></li>
<li><code>yarn dev</code> - build a development version of the API in <code>dist/opennms.js</code> and <code>dist/opennms.node.js</code></li>
<li><code>yarn build</code> - build the development and production versions of the API in <code>dist/</code></li>
<li><code>yarn docs</code> - build the docs in <code>dist/docs/</code></li>
<li><code>yarn watch</code> - continuously build the development version in <code>dist/opennms.js</code></li>
<li><code>yarn test</code> - run the tests</li>
<li><code>yarn watch-test</code> - continuously run the tests</li>
<li><code>yarn cli -- <arguments></code> - run the CLI test tool (try <code>--help</code> for options)</li>
</ul>
<h1 id="reporting-bugs-or-feature-requests">Reporting Bugs or Feature Requests</h1>
<p>OpenNMS.js issues are tracked in the OpenNMS issue tracker: <a href="https://issues.opennms.org/browse/JS">https://issues.opennms.org/browse/JS</a></p>
<h1 id="debugging-tests">Debugging Tests</h1>
<p>On MAC OS X with WebStorm v2017.2 debugging tests may not work.
See <a href="https://github.com/facebook/jest/issues/1652">https://github.com/facebook/jest/issues/1652</a> for more details.
The described solution there is to add <code>--env jest-environment-node-debug</code> as argument to the runtime configuration.</p>
</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"><em>Globals</em></a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/abstractdao.html" class="tsd-kind-icon">AbstractDAO</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/abstracthttp.html" class="tsd-kind-icon">AbstractHTTP</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/alarmdao.html" class="tsd-kind-icon">AlarmDAO</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/axioshttp.html" class="tsd-kind-icon">AxiosHTTP</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/basedao.html" class="tsd-kind-icon">BaseDAO</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/clause.html" class="tsd-kind-icon">Clause</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/client.html" class="tsd-kind-icon">Client</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/comparator.html" class="tsd-kind-icon">Comparator</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/eventdao.html" class="tsd-kind-icon">EventDAO</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/filter.html" class="tsd-kind-icon">Filter</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/flowdao.html" class="tsd-kind-icon">FlowDAO</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/grafanaerror.html" class="tsd-kind-icon">Grafana<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/grafanahttp.html" class="tsd-kind-icon">GrafanaHTTP</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/jsontransformer.html" class="tsd-kind-icon">Json<wbr>Transformer</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/nestedrestriction.html" class="tsd-kind-icon">Nested<wbr>Restriction</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/nodedao.html" class="tsd-kind-icon">NodeDAO</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsalarm.html" class="tsd-kind-icon">Onms<wbr>Alarm</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsalarmsummary.html" class="tsd-kind-icon">Onms<wbr>Alarm<wbr>Summary</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsalarmtype.html" class="tsd-kind-icon">Onms<wbr>Alarm<wbr>Type</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsauthconfig.html" class="tsd-kind-icon">Onms<wbr>Auth<wbr>Config</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmscategory.html" class="tsd-kind-icon">Onms<wbr>Category</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmscollecttype.html" class="tsd-kind-icon">Onms<wbr>Collect<wbr>Type</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/onmsenum.html" class="tsd-kind-icon">Onms<wbr>Enum</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmserror.html" class="tsd-kind-icon">Onms<wbr>Error</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsevent.html" class="tsd-kind-icon">Onms<wbr>Event</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsflowexporter.html" class="tsd-kind-icon">Onms<wbr>Flow<wbr>Exporter</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsflowexportersummary.html" class="tsd-kind-icon">Onms<wbr>Flow<wbr>Exporter<wbr>Summary</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsflowseries.html" class="tsd-kind-icon">Onms<wbr>Flow<wbr>Series</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsflowseriescolumn.html" class="tsd-kind-icon">Onms<wbr>Flow<wbr>Series<wbr>Column</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsflowsnmpinterface.html" class="tsd-kind-icon">Onms<wbr>Flow<wbr>Snmp<wbr>Interface</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsflowtable.html" class="tsd-kind-icon">Onms<wbr>Flow<wbr>Table</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmshttpoptions.html" class="tsd-kind-icon">OnmsHTTPOptions</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsipinterface.html" class="tsd-kind-icon">Onms<wbr>IpInterface</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsmanagedtype.html" class="tsd-kind-icon">Onms<wbr>Managed<wbr>Type</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsmemo.html" class="tsd-kind-icon">Onms<wbr>Memo</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsmonitoredservice.html" class="tsd-kind-icon">Onms<wbr>Monitored<wbr>Service</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsnode.html" class="tsd-kind-icon">Onms<wbr>Node</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsnodelabelsource.html" class="tsd-kind-icon">Onms<wbr>Node<wbr>Label<wbr>Source</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsnodetype.html" class="tsd-kind-icon">Onms<wbr>Node<wbr>Type</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsparm.html" class="tsd-kind-icon">Onms<wbr>Parm</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsprimarytype.html" class="tsd-kind-icon">Onms<wbr>Primary<wbr>Type</a>
</li>
<li class=" tsd-kind-class tsd-has-type-parameter">
<a href="classes/onmsresult.html" class="tsd-kind-icon">Onms<wbr>Result</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsserver.html" class="tsd-kind-icon">Onms<wbr>Server</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsservicestatustype.html" class="tsd-kind-icon">Onms<wbr>Service<wbr>Status<wbr>Type</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsservicetype.html" class="tsd-kind-icon">Onms<wbr>Service<wbr>Type</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsseverity.html" class="tsd-kind-icon">Onms<wbr>Severity</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmssituationfeedback.html" class="tsd-kind-icon">Onms<wbr>Situation<wbr>Feedback</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmssituationfeedbacktype.html" class="tsd-kind-icon">Onms<wbr>Situation<wbr>Feedback<wbr>Type</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmssnmpinterface.html" class="tsd-kind-icon">Onms<wbr>Snmp<wbr>Interface</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmssnmpstatustype.html" class="tsd-kind-icon">Onms<wbr>Snmp<wbr>Status<wbr>Type</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmstroubleticketstate.html" class="tsd-kind-icon">Onms<wbr>Trouble<wbr>Ticket<wbr>State</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/onmsversion.html" class="tsd-kind-icon">Onms<wbr>Version</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/operator.html" class="tsd-kind-icon">Operator</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/physaddr.html" class="tsd-kind-icon">Phys<wbr>Addr</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/propertiescache.html" class="tsd-kind-icon">Properties<wbr>Cache</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/restriction.html" class="tsd-kind-icon">Restriction</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/searchproperty.html" class="tsd-kind-icon">Search<wbr>Property</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/searchpropertytype.html" class="tsd-kind-icon">Search<wbr>Property<wbr>Type</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/servermetadata.html" class="tsd-kind-icon">Server<wbr>Metadata</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/servertype.html" class="tsd-kind-icon">Server<wbr>Type</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/situationfeedbackdao.html" class="tsd-kind-icon">Situation<wbr>FeedbackDAO</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/ticketerconfig.html" class="tsd-kind-icon">Ticketer<wbr>Config</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/uuid.html" class="tsd-kind-icon">UUID</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/util.html" class="tsd-kind-icon">Util</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/v1filterprocessor.html" class="tsd-kind-icon">V1<wbr>Filter<wbr>Processor</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/v2filterprocessor.html" class="tsd-kind-icon">V2<wbr>Filter<wbr>Processor</a>
</li>
<li class=" tsd-kind-class">
<a href="classes/xmltransformer.html" class="tsd-kind-icon">Xml<wbr>Transformer</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ifilterprocessor.html" class="tsd-kind-icon">IFilter<wbr>Processor</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ihashttp.html" class="tsd-kind-icon">IHasHTTP</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ihasurlvalue.html" class="tsd-kind-icon">IHas<wbr>Url<wbr>Value</a>
</li>
<li class=" tsd-kind-interface tsd-has-type-parameter">
<a href="interfaces/ihash.html" class="tsd-kind-icon">IHash</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ionmshttp.html" class="tsd-kind-icon">IOnmsHTTP</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/isearchpropertyaccessor.html" class="tsd-kind-icon">ISearch<wbr>Property<wbr>Accessor</a>
</li>
<li class=" tsd-kind-interface">
<a href="interfaces/ivalueprovider.html" class="tsd-kind-icon">IValue<wbr>Provider</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#auth_prop" class="tsd-kind-icon">AUTH_<wbr>PROP</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#default_timeout" class="tsd-kind-icon">DEFAULT_<wbr>TIMEOUT</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#options_prop" class="tsd-kind-icon">OPTIONS_<wbr>PROP</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#timeout_prop" class="tsd-kind-icon">TIMEOUT_<wbr>PROP</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#namepattern" class="tsd-kind-icon">name<wbr>Pattern</a>
</li>
<li class=" tsd-kind-variable tsd-is-not-exported">
<a href="globals.html#symbolpattern" class="tsd-kind-icon">symbol<wbr>Pattern</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#alarmtypes" class="tsd-kind-icon">Alarm<wbr>Types</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#collecttypes" class="tsd-kind-icon">Collect<wbr>Types</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#comparators" class="tsd-kind-icon">Comparators</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#feedbacktypes" class="tsd-kind-icon">Feedback<wbr>Types</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#managedtypes" class="tsd-kind-icon">Managed<wbr>Types</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#nodelabelsources" class="tsd-kind-icon">Node<wbr>Label<wbr>Sources</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#nodetypes" class="tsd-kind-icon">Node<wbr>Types</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#operators" class="tsd-kind-icon">Operators</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#primarytypes" class="tsd-kind-icon">Primary<wbr>Types</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#searchpropertytypes" class="tsd-kind-icon">Search<wbr>Property<wbr>Types</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#servertypes" class="tsd-kind-icon">Server<wbr>Types</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#servicestatustypes" class="tsd-kind-icon">Service<wbr>Status<wbr>Types</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#severities" class="tsd-kind-icon">Severities</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#snmpstatustypes" class="tsd-kind-icon">Snmp<wbr>Status<wbr>Types</a>
</li>
<li class=" tsd-kind-object-literal tsd-is-not-exported">
<a href="globals.html#troubleticketstates" class="tsd-kind-icon">Trouble<wbr>Ticket<wbr>States</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-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>