opennms
Version:
Client API for the OpenNMS network monitoring platform
510 lines • 28.3 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>V2FilterProcessor | 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>
<li>
<a href="v2filterprocessor.html">V2FilterProcessor</a>
</li>
</ul>
<h1>Class V2FilterProcessor</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>Converts a <a href="filter.html">Filter</a> into ReSTv2 FIQL parameters.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">V2FilterProcessor</span>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/ifilterprocessor.html" class="tsd-signature-type">IFilterProcessor</a></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="v2filterprocessor.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-private"><a href="v2filterprocessor.html#searchpropertyaccessor" class="tsd-kind-icon">search<wbr>Property<wbr>Accessor</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="v2filterprocessor.html#null_date" class="tsd-kind-icon">NULL_<wbr>DATE</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="v2filterprocessor.html#null_value" class="tsd-kind-icon">NULL_<wbr>VALUE</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 tsd-is-private"><a href="v2filterprocessor.html#applydateconversion" class="tsd-kind-icon">apply<wbr>Date<wbr>Conversion</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="v2filterprocessor.html#getparameters" class="tsd-kind-icon">get<wbr>Parameters</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="v2filterprocessor.html#tofiql" class="tsd-kind-icon">toFIQL</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="v2filterprocessor.html#tofiqlcomparator" class="tsd-kind-icon">toFIQLComparator</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="v2filterprocessor.html#tofiqloperator" class="tsd-kind-icon">toFIQLOperator</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="v2filterprocessor.html#tofiqlvalue" class="tsd-kind-icon">toFIQLValue</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>V2Filter<wbr>Processor<span class="tsd-signature-symbol">(</span>searchPropertyAccessor<span class="tsd-signature-symbol">?: </span><a href="../interfaces/isearchpropertyaccessor.html" class="tsd-signature-type">ISearchPropertyAccessor</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="v2filterprocessor.html" class="tsd-signature-type">V2FilterProcessor</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/V2FilterProcessor.ts#L38">dao/V2FilterProcessor.ts:38</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> searchPropertyAccessor: <a href="../interfaces/isearchpropertyaccessor.html" class="tsd-signature-type">ISearchPropertyAccessor</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="v2filterprocessor.html" class="tsd-signature-type">V2FilterProcessor</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-private">
<a name="searchpropertyaccessor" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> search<wbr>Property<wbr>Accessor</h3>
<div class="tsd-signature tsd-kind-icon">search<wbr>Property<wbr>Accessor<span class="tsd-signature-symbol">:</span> <a href="../interfaces/isearchpropertyaccessor.html" class="tsd-signature-type">ISearchPropertyAccessor</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/V2FilterProcessor.ts#L38">dao/V2FilterProcessor.ts:38</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The accessor for Properties</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a name="null_date" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> NULL_<wbr>DATE</h3>
<div class="tsd-signature tsd-kind-icon">NULL_<wbr>DATE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "1970-01-01T00:00:00.000+0000"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/V2FilterProcessor.ts#L29">dao/V2FilterProcessor.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constant used to represent null dates in the V2 API.
This must be explicitly set as the restriction value when using
either the NULL or NOTNULL comparators on date fields.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a name="null_value" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> NULL_<wbr>VALUE</h3>
<div class="tsd-signature tsd-kind-icon">NULL_<wbr>VALUE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = " "</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/V2FilterProcessor.ts#L23">dao/V2FilterProcessor.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constant used to represent null values in the V2 API.</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 tsd-is-private">
<a name="applydateconversion" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> apply<wbr>Date<wbr>Conversion</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">apply<wbr>Date<wbr>Conversion<span class="tsd-signature-symbol">(</span>value<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">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/V2FilterProcessor.ts#L144">dao/V2FilterProcessor.ts:144</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If the given value is a date value, it is converted to be properly parsed by the OpenNMS ReST API,
otherwise it is not modified.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Any value which may need conversion.</p>
</div>
</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">
<a name="getparameters" class="tsd-anchor"></a>
<h3>get<wbr>Parameters</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Parameters<span class="tsd-signature-symbol">(</span>filter<span class="tsd-signature-symbol">: </span><a href="filter.html" class="tsd-signature-type">Filter</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/ihash.html" class="tsd-signature-type">IHash</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/ifilterprocessor.html">IFilterProcessor</a>.<a href="../interfaces/ifilterprocessor.html#getparameters">getParameters</a></p>
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/V2FilterProcessor.ts#L45">dao/V2FilterProcessor.ts:45</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Given a filter, return a hash of URL parameters.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>filter: <a href="filter.html" class="tsd-signature-type">Filter</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/ihash.html" class="tsd-signature-type">IHash</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="tofiql" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> toFIQL</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">toFIQL<span class="tsd-signature-symbol">(</span>clauses<span class="tsd-signature-symbol">: </span><a href="clause.html" class="tsd-signature-type">Clause</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/V2FilterProcessor.ts#L119">dao/V2FilterProcessor.ts:119</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Given a list of clauses, recursively generate the FIQL query string.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>clauses: <a href="clause.html" class="tsd-signature-type">Clause</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="tofiqlcomparator" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> toFIQLComparator</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">toFIQLComparator<span class="tsd-signature-symbol">(</span>comparator<span class="tsd-signature-symbol">: </span><a href="comparator.html" class="tsd-signature-type">Comparator</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">"=="</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"!="</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"=gt="</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"=lt="</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"=ge="</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"=le="</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/V2FilterProcessor.ts#L64">dao/V2FilterProcessor.ts:64</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Given a comparator, convert it to a correspond comparator
that can be used in the FIQL expression.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>comparator: <a href="comparator.html" class="tsd-signature-type">Comparator</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">"=="</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">"!="</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">"=gt="</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">"=lt="</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">"=ge="</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">"=le="</span>
</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="tofiqloperator" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> toFIQLOperator</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">toFIQLOperator<span class="tsd-signature-symbol">(</span>operator<span class="tsd-signature-symbol">: </span><a href="operator.html" class="tsd-signature-type">Operator</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">";"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">","</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/V2FilterProcessor.ts#L107">dao/V2FilterProcessor.ts:107</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Given an operator, convert it to the corresponding FIQL operator.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>operator: <a href="operator.html" class="tsd-signature-type">Operator</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">";"</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">","</span>
</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="tofiqlvalue" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> toFIQLValue</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">toFIQLValue<span class="tsd-signature-symbol">(</span>restriction<span class="tsd-signature-symbol">: </span><a href="restriction.html" class="tsd-signature-type">Restriction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/OpenNMS/opennms-js/blob/2769035/src/dao/V2FilterProcessor.ts#L89">dao/V2FilterProcessor.ts:89</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Given a restriction, compute the value to use in the FIQL expression.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>restriction: <a href="restriction.html" class="tsd-signature-type">Restriction</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</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="globals ">
<a href="../globals.html"><em>Globals</em></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">
<a href="v2filterprocessor.html" class="tsd-kind-icon">V2<wbr>Filter<wbr>Processor</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="v2filterprocessor.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="v2filterprocessor.html#searchpropertyaccessor" class="tsd-kind-icon">search<wbr>Property<wbr>Accessor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a href="v2filterprocessor.html#null_date" class="tsd-kind-icon">NULL_<wbr>DATE</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a href="v2filterprocessor.html#null_value" class="tsd-kind-icon">NULL_<wbr>VALUE</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="v2filterprocessor.html#applydateconversion" class="tsd-kind-icon">apply<wbr>Date<wbr>Conversion</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="v2filterprocessor.html#getparameters" class="tsd-kind-icon">get<wbr>Parameters</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="v2filterprocessor.html#tofiql" class="tsd-kind-icon">toFIQL</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="v2filterprocessor.html#tofiqlcomparator" class="tsd-kind-icon">toFIQLComparator</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="v2filterprocessor.html#tofiqloperator" class="tsd-kind-icon">toFIQLOperator</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="v2filterprocessor.html#tofiqlvalue" class="tsd-kind-icon">toFIQLValue</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>