@quenk/wml-runtime
Version:
Runtime for compiled wml files.
774 lines • 47.1 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>"index" | @quenk/wml-runtime</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">@quenk/wml-runtime</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="_index_.html">"index"</a>
</li>
</ul>
<h1>External module "index"</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 tsd-has-type-parameter"><a href="../classes/_index_.appview.html" class="tsd-kind-icon">App<wbr>View</a></li>
<li class="tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter"><a href="../classes/_index_.component.html" class="tsd-kind-icon">Component</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 tsd-has-type-parameter"><a href="../interfaces/_index_.attributemap.html" class="tsd-kind-icon">Attribute<wbr>Map</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_index_.attrs.html" class="tsd-kind-icon">Attrs</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private"><a href="../interfaces/_index_.forecallback.html" class="tsd-kind-icon">ForECallback</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_index_.renderable.html" class="tsd-kind-icon">Renderable</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-is-private"><a href="../interfaces/_index_.switchecase.html" class="tsd-kind-icon">SwitchECase</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter"><a href="../interfaces/_index_.template.html" class="tsd-kind-icon">Template</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_index_.view.html" class="tsd-kind-icon">View</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module"><a href="../interfaces/_index_.widget.html" class="tsd-kind-icon">Widget</a></li>
<li class="tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private"><a href="../interfaces/_index_.widgetconstructor.html" class="tsd-kind-icon">Widget<wbr>Constructor</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="_index_.html#content" class="tsd-kind-icon">Content</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-private tsd-is-not-exported"><a href="_index_.html#iterable" class="tsd-kind-icon">Iterable</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-external-module"><a href="_index_.html#wmlelement" class="tsd-kind-icon">WMLElement</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected tsd-is-not-exported">
<h3>Variables</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-variable tsd-parent-kind-external-module tsd-is-private tsd-is-not-exported"><a href="_index_.html#_empty" class="tsd-kind-icon">_empty</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Functions</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-private tsd-is-not-exported"><a href="_index_.html#adopt" class="tsd-kind-icon">adopt</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-private"><a href="_index_.html#box" class="tsd-kind-icon">box</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private"><a href="_index_.html#domify" class="tsd-kind-icon">domify</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-private"><a href="_index_.html#empty" class="tsd-kind-icon">empty</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private"><a href="_index_.html#fore" class="tsd-kind-icon">forE</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private"><a href="_index_.html#ife" class="tsd-kind-icon">ifE</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private"><a href="_index_.html#node" class="tsd-kind-icon">node</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private"><a href="_index_.html#read" class="tsd-kind-icon">read</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-private"><a href="_index_.html#switche" class="tsd-kind-icon">switchE</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-is-private"><a href="_index_.html#text" class="tsd-kind-icon">text</a></li>
<li class="tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private"><a href="_index_.html#widget-1" class="tsd-kind-icon">widget</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="content" class="tsd-anchor"></a>
<h3>Content</h3>
<div class="tsd-signature tsd-kind-icon">Content<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Node</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Element</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">HTMLElement</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L14">index.ts:14</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Content is what is actually intended to be rendered on a web page.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-private tsd-is-not-exported">
<a name="iterable" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> Iterable</h3>
<div class="tsd-signature tsd-kind-icon">Iterable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">V</span><span class="tsd-signature-symbol">[]</span><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/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L23">index.ts:23</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-external-module">
<a name="wmlelement" class="tsd-anchor"></a>
<h3>WMLElement</h3>
<div class="tsd-signature tsd-kind-icon">WMLElement<span class="tsd-signature-symbol">:</span> <a href="_index_.html#content" class="tsd-signature-type">Content</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_index_.widget.html" class="tsd-signature-type">Widget</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L6">index.ts:6</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>WMLElement can be DOM content or a user defined widget.</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected tsd-is-not-exported">
<h2>Variables</h2>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-external-module tsd-is-private tsd-is-not-exported">
<a name="_empty" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> _empty</h3>
<div class="tsd-signature tsd-kind-icon">_empty<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">DocumentFragment</span><span class="tsd-signature-symbol"> = document.createDocumentFragment()</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L248">index.ts:248</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Functions</h2>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-private tsd-is-not-exported">
<a name="adopt" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> adopt</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-private tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">adopt<span class="tsd-signature-symbol">(</span>child<span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a>, e<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Node</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 <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L186">index.ts:186</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>child: <a href="_index_.html#content" class="tsd-signature-type">Content</a></h5>
</li>
<li>
<h5>e: <span class="tsd-signature-type">Node</span></h5>
</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-function tsd-parent-kind-external-module tsd-is-private">
<a name="box" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> box</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-private">
<li class="tsd-signature tsd-kind-icon">box<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>content<span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L206">index.ts:206</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>content: <a href="_index_.html#content" class="tsd-signature-type">Content</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_index_.html#content" class="tsd-signature-type">Content</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a name="domify" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> domify</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<li class="tsd-signature tsd-kind-icon">domify<A><span class="tsd-signature-symbol">(</span>a<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L217">index.ts:217</a></li>
</ul>
</aside>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>A</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>a: <span class="tsd-signature-type">A</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_index_.html#content" class="tsd-signature-type">Content</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-private">
<a name="empty" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> empty</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-private">
<li class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">DocumentFragment</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L253">index.ts:253</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">DocumentFragment</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a name="fore" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> forE</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<li class="tsd-signature tsd-kind-icon">forE<V><span class="tsd-signature-symbol">(</span>collection<span class="tsd-signature-symbol">: </span><a href="_index_.html#iterable" class="tsd-signature-type">Iterable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">V</span><span class="tsd-signature-symbol">></span>, cb<span class="tsd-signature-symbol">: </span><a href="../interfaces/_index_.forecallback.html" class="tsd-signature-type">ForECallback</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">V</span><span class="tsd-signature-symbol">></span>, cb2<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L377">index.ts:377</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>forE provides a for expression</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>V</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>collection: <a href="_index_.html#iterable" class="tsd-signature-type">Iterable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">V</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5>cb: <a href="../interfaces/_index_.forecallback.html" class="tsd-signature-type">ForECallback</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">V</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5>cb2: <span class="tsd-signature-type">function</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="_index_.html#content" class="tsd-signature-type">Content</a></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_index_.html#content" class="tsd-signature-type">Content</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a name="ife" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> ifE</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<li class="tsd-signature tsd-kind-icon">ifE<P><span class="tsd-signature-symbol">(</span>predicate<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">P</span>, positive<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, negative<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Node</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L361">index.ts:361</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>ifE provides an if then expression</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>P</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>predicate: <span class="tsd-signature-type">P</span></h5>
</li>
<li>
<h5>positive: <span class="tsd-signature-type">function</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="_index_.html#content" class="tsd-signature-type">Content</a></h4>
</li>
</ul>
</li>
</ul>
</li>
<li>
<h5>negative: <span class="tsd-signature-type">function</span></h5>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="_index_.html#content" class="tsd-signature-type">Content</a></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Node</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a name="node" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> node</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<li class="tsd-signature tsd-kind-icon">node<A, C><span class="tsd-signature-symbol">(</span>tag<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, attributes<span class="tsd-signature-symbol">: </span><a href="../interfaces/_index_.attributemap.html" class="tsd-signature-type">AttributeMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">></span>, children<span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a><span class="tsd-signature-symbol">[]</span>, view<span class="tsd-signature-symbol">: </span><a href="../classes/_index_.appview.html" class="tsd-signature-type">AppView</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Node</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L266">index.ts:266</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>node is called to create a regular DOM node</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>A</h4>
</li>
<li>
<h4>C</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tag: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>attributes: <a href="../interfaces/_index_.attributemap.html" class="tsd-signature-type">AttributeMap</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5>children: <a href="_index_.html#content" class="tsd-signature-type">Content</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>view: <a href="../classes/_index_.appview.html" class="tsd-signature-type">AppView</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">C</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Node</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a name="read" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> read</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<li class="tsd-signature tsd-kind-icon">read<A><span class="tsd-signature-symbol">(</span>path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, o<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">object</span>, defaultValue<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">A</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L175">index.ts:175</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>read a value form an object.</p>
</div>
<p>This is an alternative to regular property access that will throw exceptions
if any of the values in the part are null.</p>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>A</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>o: <span class="tsd-signature-type">object</span></h5>
</li>
<li>
<h5>defaultValue: <span class="tsd-signature-type">A</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>This value is returned if the value is not set.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">A</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-private">
<a name="switche" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> switchE</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-private">
<li class="tsd-signature tsd-kind-icon">switchE<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, cases<span class="tsd-signature-symbol">: </span><a href="../interfaces/_index_.switchecase.html" class="tsd-signature-type">SwitchECase</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L421">index.ts:421</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>switchE simulates a switch statement</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>cases: <a href="../interfaces/_index_.switchecase.html" class="tsd-signature-type">SwitchECase</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">function</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="_index_.html#content" class="tsd-signature-type">Content</a></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-is-private">
<a name="text" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> text</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-is-private">
<li class="tsd-signature tsd-kind-icon">text<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><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">Text</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L259">index.ts:259</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>text creates a new TextNode.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Text</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a name="widget-1" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> widget</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<li class="tsd-signature tsd-kind-icon">widget<C, A><span class="tsd-signature-symbol">(</span>Constructor<span class="tsd-signature-symbol">: </span><a href="../interfaces/_index_.widgetconstructor.html" class="tsd-signature-type">WidgetConstructor</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">></span>, attributes<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">A</span>, children<span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a><span class="tsd-signature-symbol">[]</span>, view<span class="tsd-signature-symbol">: </span><a href="../classes/_index_.appview.html" class="tsd-signature-type">AppView</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">C</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_index_.html#content" class="tsd-signature-type">Content</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/quenktechnologies/wml-runtime/blob/6d2689d/src/index.ts#L327">index.ts:327</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>widget creates and renders a new wml widget instance.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>C</h4>
</li>
<li>
<h4>A</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>Constructor: <a href="../interfaces/_index_.widgetconstructor.html" class="tsd-signature-type">WidgetConstructor</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">A</span><span class="tsd-signature-symbol">></span></h5>
</li>
<li>
<h5>attributes: <span class="tsd-signature-type">A</span></h5>
</li>
<li>
<h5>children: <a href="_index_.html#content" class="tsd-signature-type">Content</a><span class="tsd-signature-symbol">[]</span></h5>
</li>
<li>
<h5>view: <a href="../classes/_index_.appview.html" class="tsd-signature-type">AppView</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">C</span><span class="tsd-signature-symbol">></span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_index_.html#content" class="tsd-signature-type">Content</a></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="_index_.html">"index"</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 tsd-has-type-parameter">
<a href="../classes/_index_.appview.html" class="tsd-kind-icon">App<wbr>View</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../classes/_index_.component.html" class="tsd-kind-icon">Component</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../interfaces/_index_.attributemap.html" class="tsd-kind-icon">Attribute<wbr>Map</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_index_.attrs.html" class="tsd-kind-icon">Attrs</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a href="../interfaces/_index_.forecallback.html" class="tsd-kind-icon">ForECallback</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_index_.renderable.html" class="tsd-kind-icon">Renderable</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-is-private">
<a href="../interfaces/_index_.switchecase.html" class="tsd-kind-icon">SwitchECase</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../interfaces/_index_.template.html" class="tsd-kind-icon">Template</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_index_.view.html" class="tsd-kind-icon">View</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_index_.widget.html" class="tsd-kind-icon">Widget</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a href="../interfaces/_index_.widgetconstructor.html" class="tsd-kind-icon">Widget<wbr>Constructor</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_index_.html#content" class="tsd-kind-icon">Content</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module tsd-is-private tsd-is-not-exported">
<a href="_index_.html#iterable" class="tsd-kind-icon">Iterable</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-external-module">
<a href="_index_.html#wmlelement" class="tsd-kind-icon">WMLElement</a>
</li>
<li class=" tsd-kind-variable tsd-parent-kind-external-module tsd-is-private tsd-is-not-exported">
<a href="_index_.html#_empty" class="tsd-kind-icon">_empty</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-private tsd-is-not-exported">
<a href="_index_.html#adopt" class="tsd-kind-icon">adopt</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-private">
<a href="_index_.html#box" class="tsd-kind-icon">box</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a href="_index_.html#domify" class="tsd-kind-icon">domify</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-private">
<a href="_index_.html#empty" class="tsd-kind-icon">empty</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a href="_index_.html#fore" class="tsd-kind-icon">forE</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a href="_index_.html#ife" class="tsd-kind-icon">ifE</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a href="_index_.html#node" class="tsd-kind-icon">node</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a href="_index_.html#read" class="tsd-kind-icon">read</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-private">
<a href="_index_.html#switche" class="tsd-kind-icon">switchE</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-is-private">
<a href="_index_.html#text" class="tsd-kind-icon">text</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-external-module tsd-has-type-parameter tsd-is-private">
<a href="_index_.html#widget-1" class="tsd-kind-icon">widget</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>