UNPKG

com.phloxui

Version:

PhloxUI Ng2+ Framework

564 lines 30.5 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ObservableManager | com.phloxui</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">com.phloxui</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/_service_observablemanager_service_.html">&quot;service/ObservableManager.service&quot;</a> </li> <li> <a href="_service_observablemanager_service_.observablemanager.html">ObservableManager</a> </li> </ul> <h1>Class ObservableManager</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 style="text-indent: 2em;"> A <code>ng</code> service which is mainly responsible for providing publish/subscribe <code>Messaging API</code>. You can easily create/publish/subscribe a <code>message topic</code> by using this service. This service uses <code>RxJS</code>&#39;s <code>Observable / Subject API</code> as a core engine. Neverthelss, it does not require you to have any background on <code>RxJS</code> since it simplifies the <code>RxJS</code>&#39;s API by providing a new way to use it. For example, in <code>RxJS</code>&#39;s normal way, you may need to keep a reference to an <code>Subject</code> object all the time in which that the <code>message topic</code> is still active. Moreover, if you have more <code>message topic</code>s to handle, you must keep more <code>Subject</code> instance references separately. In spite of that, this service diminishes those struggles by mapping each <code>Subject</code> object instance to a <code>topic name</code>. When you want to interact with those topics, you could simply supply the <code>topic name</code> to this service. For more information, please see methods of this class below. </p> <p style="text-indent: 2em;"> If you only want to publish/subscribe to a topic. Please see <a href="_service_observablemanager_service_.observablemanager.html#publish">publish</a> and <a href="_service_observablemanager_service_.observablemanager.html#subscribe">subscribe</a> method below. </p> </div> <dl class="tsd-comment-tags"> <dt>author</dt> <dd><p>shiorin, tee4cute</p> </dd> </dl> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">ObservableManager</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="_service_observablemanager_service_.observablemanager.html#constructor" class="tsd-kind-icon">constructor</a></li> </ul> </section> <section class="tsd-index-section tsd-is-private tsd-is-private-protected"> <h3>Properties</h3> <ul class="tsd-index-list"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_service_observablemanager_service_.observablemanager.html#subjects" class="tsd-kind-icon">subjects</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="_service_observablemanager_service_.observablemanager.html#complete" class="tsd-kind-icon">complete</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_observablemanager_service_.observablemanager.html#containssubject" class="tsd-kind-icon">contains<wbr>Subject</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_observablemanager_service_.observablemanager.html#createsubject" class="tsd-kind-icon">create<wbr>Subject</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_observablemanager_service_.observablemanager.html#error" class="tsd-kind-icon">error</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_observablemanager_service_.observablemanager.html#getsubject" class="tsd-kind-icon">get<wbr>Subject</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_observablemanager_service_.observablemanager.html#publish" class="tsd-kind-icon">publish</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_service_observablemanager_service_.observablemanager.html#subscribe" class="tsd-kind-icon">subscribe</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>Observable<wbr>Manager<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_service_observablemanager_service_.observablemanager.html" class="tsd-signature-type">ObservableManager</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in service/ObservableManager.service.ts:25</li> </ul> </aside> <h4 class="tsd-returns-title">Returns <a href="_service_observablemanager_service_.observablemanager.html" class="tsd-signature-type">ObservableManager</a></h4> </li> </ul> </section> </section> <section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected"> <h2>Properties</h2> <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a name="subjects" class="tsd-anchor"></a> <h3><span class="tsd-flag ts-flagPrivate">Private</span> subjects</h3> <div class="tsd-signature tsd-kind-icon">subjects<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in service/ObservableManager.service.ts:25</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="complete" class="tsd-anchor"></a> <h3>complete</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">complete<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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 service/ObservableManager.service.ts:184</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Close the specified topic <code><b>name</b></code>. If there is currently no <code>message topic</code> created or no one subsribing to this topic, this method will do nothing. Otherwise, the subscriber&#39;s <code>complete handler function</code> will be triggered. Note that, we use the method name <code> complete</code> instead of <code>close</code> since we try to use the same naming as <code>RxJS</code> does as much as possible. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The message topic name to close.</p> </div> </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="containssubject" class="tsd-anchor"></a> <h3>contains<wbr>Subject</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">contains<wbr>Subject<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in service/ObservableManager.service.ts:62</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> To check that there already is <code>RxJS</code>&#39;s <code>Subject</code> object bound to the given topic <code><b>name</b></code> or not. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A message topic name to check.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="createsubject" class="tsd-anchor"></a> <h3>create<wbr>Subject</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">create<wbr>Subject<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Subject</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in service/ObservableManager.service.ts:80</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Create a new <code>Subject</code> (or topic) and map it to the given topic <code><b>name</b></code>. This method will return the old object instance if the given <code><b>&quot;name&quot;</b></code> already exists. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A message topic name to create <code>Subject</code>.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Subject</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="error" class="tsd-anchor"></a> <h3>error</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">error<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, error<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in service/ObservableManager.service.ts:160</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Signal error message to the given topic <code><b>name</b></code>. The subscriber&#39;s <code>error function</code> will be triggered with the given <code><b>error</b></code> passed as a parameter. This method will automatically create the topic if the given topic name is not created yet. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The message topic name to signal.</p> </div> </li> <li> <h5>error: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>The error message to signal.</p> </div> </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="getsubject" class="tsd-anchor"></a> <h3>get<wbr>Subject</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">get<wbr>Subject<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Subject</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in service/ObservableManager.service.ts:40</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Get the <code>RxJS</code>&#39;s <code>Subject</code> object bound to the given topic <code><b>name</b></code>. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A message topic name to get.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Subject</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h4> <p>Returns <code>null</code> if the given topic <code><b>name</b></code> is not created yet.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="publish" class="tsd-anchor"></a> <h3>publish</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">publish<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, data<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">void</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in service/ObservableManager.service.ts:135</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Publish a message (<code><b>data</b></code>) to the given topic <code><b>name</b></code>. The subscriber&#39;s <code>handler function</code> will be triggered with the given <code><b>data</b></code> passed as a parameter. This method will automatically create the topic if the given topic name is not created yet. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>The message topic name to publish.</p> </div> </li> <li> <h5>data: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>The message data to publish.</p> </div> </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="subscribe" class="tsd-anchor"></a> <h3>subscribe</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, errorHandler<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span>, completeHandler<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">Subscription</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in service/ObservableManager.service.ts:110</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p style="text-indent: 1em;"> Subscribe message to the given topic <code><b>name</b></code>. This method will automatically create the topic if the given topic name is not created yet. </p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>name: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>A message topic name to subscribe.</p> </div> </li> <li> <h5>handler: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>A message <code>handler function</code> which will be triggered when message arrives.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> errorHandler: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>An error <code>handler function</code> which will be triggered when any error occurs on the [[Observer]].</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> completeHandler: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>A <code>handler function</code> which will be triggered when the topic is closed and not publishes any messages anymore.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Subscription</span></h4> <p>A <code>RxJS</code>&#39;s <code>Subscription</code> object returning from <code>Subject.subscribe()</code> method.</p> </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="current tsd-kind-external-module"> <a href="../modules/_service_observablemanager_service_.html">"service/<wbr>Observable<wbr>Manager.service"</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="_service_observablemanager_service_.observablemanager.html" class="tsd-kind-icon">Observable<wbr>Manager</a> <ul> <li class=" tsd-kind-constructor tsd-parent-kind-class"> <a href="_service_observablemanager_service_.observablemanager.html#constructor" class="tsd-kind-icon">constructor</a> </li> <li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private"> <a href="_service_observablemanager_service_.observablemanager.html#subjects" class="tsd-kind-icon">subjects</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_service_observablemanager_service_.observablemanager.html#complete" class="tsd-kind-icon">complete</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_service_observablemanager_service_.observablemanager.html#containssubject" class="tsd-kind-icon">contains<wbr>Subject</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_service_observablemanager_service_.observablemanager.html#createsubject" class="tsd-kind-icon">create<wbr>Subject</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_service_observablemanager_service_.observablemanager.html#error" class="tsd-kind-icon">error</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_service_observablemanager_service_.observablemanager.html#getsubject" class="tsd-kind-icon">get<wbr>Subject</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_service_observablemanager_service_.observablemanager.html#publish" class="tsd-kind-icon">publish</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_service_observablemanager_service_.observablemanager.html#subscribe" class="tsd-kind-icon">subscribe</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>