UNPKG

cyclejs-modal

Version:

An easy way to open custom modals in a cyclejs app

490 lines 29.2 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>&quot;modalify&quot; | cyclejs-modal</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">cyclejs-modal</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="_modalify_.html">&quot;modalify&quot;</a> </li> </ul> <h1>External module &quot;modalify&quot;</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <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>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class tsd-parent-kind-external-module"><a href="../classes/_modalify_.modalsource.html" class="tsd-kind-icon">Modal<wbr>Source</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_modalify_.close.html" class="tsd-kind-icon">Close</a></li> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_modalify_.open.html" class="tsd-kind-icon">Open</a></li> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_modalify_.options.html" class="tsd-kind-icon">Options</a></li> <li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_modalify_.sinksobject.html" class="tsd-kind-icon">Sinks<wbr>Object</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_modalify_.html#component" class="tsd-kind-icon">Component</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_modalify_.html#modalaction" class="tsd-kind-icon">Modal<wbr>Action</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-not-exported"><a href="_modalify_.html#modalstack" class="tsd-kind-icon">Modal<wbr>Stack</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_modalify_.html#scope" class="tsd-kind-icon">Scope</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_modalify_.html#sinks" class="tsd-kind-icon">Sinks</a></li> <li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_modalify_.html#sources" class="tsd-kind-icon">Sources</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Functions</h3> <ul class="tsd-index-list"> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_modalify_.html#addstyles" class="tsd-kind-icon">add<wbr>Styles</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_modalify_.html#centerhtml" class="tsd-kind-icon">centerHTML</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_modalify_.html#displaymodals" class="tsd-kind-icon">display<wbr>Modals</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module"><a href="_modalify_.html#modalify" class="tsd-kind-icon">modalify</a></li> <li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"><a href="_modalify_.html#wrapmodals" class="tsd-kind-icon">wrap<wbr>Modals</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="component" class="tsd-anchor"></a> <h3>Component</h3> <div class="tsd-signature tsd-kind-icon">Component<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">function</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/9c34fef/src/modalify.ts#L9">modalify.ts:9</a></li> </ul> </aside> <div class="tsd-type-declaration"> <h4>Type declaration</h4> <ul class="tsd-parameters"> <li class="tsd-parameter-siganture"> <ul class="tsd-signatures tsd-kind-type-literal tsd-parent-kind-type-alias tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>s<span class="tsd-signature-symbol">: </span><a href="_modalify_.html#sources" class="tsd-signature-type">Sources</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_modalify_.html#sinks" class="tsd-signature-type">Sinks</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>s: <a href="_modalify_.html#sources" class="tsd-signature-type">Sources</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_modalify_.html#sinks" class="tsd-signature-type">Sinks</a></h4> </li> </ul> </li> </ul> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="modalaction" class="tsd-anchor"></a> <h3>Modal<wbr>Action</h3> <div class="tsd-signature tsd-kind-icon">Modal<wbr>Action<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_modalify_.open.html" class="tsd-signature-type">Open</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_modalify_.close.html" class="tsd-signature-type">Close</a></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/9c34fef/src/modalify.ts#L26">modalify.ts:26</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-not-exported"> <a name="modalstack" class="tsd-anchor"></a> <h3>Modal<wbr>Stack</h3> <div class="tsd-signature tsd-kind-icon">Modal<wbr>Stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Array</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-symbol">[</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol">, </span><a href="_modalify_.html#scope" class="tsd-signature-type">Scope</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">, </span><a href="_modalify_.html#sinks" class="tsd-signature-type">Sinks</a><span class="tsd-signature-symbol">]</span><span class="tsd-signature-symbol">&gt;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/9c34fef/src/modalify.ts#L87">modalify.ts:87</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="scope" class="tsd-anchor"></a> <h3>Scope</h3> <div class="tsd-signature tsd-kind-icon">Scope<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/9c34fef/src/modalify.ts#L38">modalify.ts:38</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="sinks" class="tsd-anchor"></a> <h3>Sinks</h3> <div class="tsd-signature tsd-kind-icon">Sinks<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/9c34fef/src/modalify.ts#L7">modalify.ts:7</a></li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module"> <a name="sources" class="tsd-anchor"></a> <h3>Sources</h3> <div class="tsd-signature tsd-kind-icon">Sources<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/9c34fef/src/modalify.ts#L8">modalify.ts:8</a></li> </ul> </aside> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Functions</h2> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="addstyles" class="tsd-anchor"></a> <h3>add<wbr>Styles</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">add<wbr>Styles<span class="tsd-signature-symbol">(</span>styles<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, vnode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VNode</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/9c34fef/src/modalify.ts#L331">modalify.ts:331</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>styles: <span class="tsd-signature-type">object</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter-index-signature"> <h5><span class="tsd-signature-symbol">[</span>k: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">any</span></h5> </li> </ul> </li> <li> <h5>vnode: <span class="tsd-signature-type">VNode</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">VNode</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="centerhtml" class="tsd-anchor"></a> <h3>centerHTML</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">centerHTML<span class="tsd-signature-symbol">(</span>children<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VNode</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/9c34fef/src/modalify.ts#L243">modalify.ts:243</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>children: <span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">[]</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">VNode</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="displaymodals" class="tsd-anchor"></a> <h3>display<wbr>Modals</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">display<wbr>Modals<span class="tsd-signature-symbol">(</span>modals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">[]</span>, background<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, zIndex<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VNode</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/9c34fef/src/modalify.ts#L274">modalify.ts:274</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>modals: <span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> background: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;rgba(0,0,0,0.8)&quot;</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> zIndex: <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;500</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">VNode</span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module"> <a name="modalify" class="tsd-anchor"></a> <h3>modalify</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module"> <li class="tsd-signature tsd-kind-icon">modalify<span class="tsd-signature-symbol">(</span>main<span class="tsd-signature-symbol">: </span><a href="_modalify_.html#component" class="tsd-signature-type">Component</a>, __namedParameters<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_modalify_.html#component" class="tsd-signature-type">Component</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/9c34fef/src/modalify.ts#L89">modalify.ts:89</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>main: <a href="_modalify_.html#component" class="tsd-signature-type">Component</a></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> __namedParameters: <span class="tsd-signature-type">object</span><span class="tsd-signature-symbol"> =&nbsp;{}</span></h5> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5>DOMDriver<wbr>Key<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>background<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>center<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></h5> </li> <li class="tsd-parameter"> <h5>modal<wbr>Container<wbr>Class<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>wrapper<wbr>Class<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5> </li> <li class="tsd-parameter"> <h5>z<wbr>Index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5> </li> </ul> </li> </ul> <h4 class="tsd-returns-title">Returns <a href="_modalify_.html#component" class="tsd-signature-type">Component</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a name="wrapmodals" class="tsd-anchor"></a> <h3>wrap<wbr>Modals</h3> <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <li class="tsd-signature tsd-kind-icon">wrap<wbr>Modals<span class="tsd-signature-symbol">(</span>modals<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">[]</span>, containerClass<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">[]</span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/cyclejs-community/cyclejs-modal/blob/9c34fef/src/modalify.ts#L302">modalify.ts:302</a></li> </ul> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>modals: <span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">[]</span></h5> </li> <li> <h5><span class="tsd-flag ts-flagDefault value">Default value</span> containerClass: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> =&nbsp;null</span></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">VNode</span><span class="tsd-signature-symbol">[]</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> <li class="current tsd-kind-external-module"> <a href="_modalify_.html">"modalify"</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class tsd-parent-kind-external-module"> <a href="../classes/_modalify_.modalsource.html" class="tsd-kind-icon">Modal<wbr>Source</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_modalify_.close.html" class="tsd-kind-icon">Close</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_modalify_.open.html" class="tsd-kind-icon">Open</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_modalify_.options.html" class="tsd-kind-icon">Options</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_modalify_.sinksobject.html" class="tsd-kind-icon">Sinks<wbr>Object</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_modalify_.html#component" class="tsd-kind-icon">Component</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_modalify_.html#modalaction" class="tsd-kind-icon">Modal<wbr>Action</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_modalify_.html#modalstack" class="tsd-kind-icon">Modal<wbr>Stack</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_modalify_.html#scope" class="tsd-kind-icon">Scope</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_modalify_.html#sinks" class="tsd-kind-icon">Sinks</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-external-module"> <a href="_modalify_.html#sources" class="tsd-kind-icon">Sources</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_modalify_.html#addstyles" class="tsd-kind-icon">add<wbr>Styles</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_modalify_.html#centerhtml" class="tsd-kind-icon">centerHTML</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_modalify_.html#displaymodals" class="tsd-kind-icon">display<wbr>Modals</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module"> <a href="_modalify_.html#modalify" class="tsd-kind-icon">modalify</a> </li> <li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-not-exported"> <a href="_modalify_.html#wrapmodals" class="tsd-kind-icon">wrap<wbr>Modals</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>