docs/classes/_core_aych_.aych.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Aych</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>
<ul class="results-priority" style="display:none">
</ul>
<a href="../index.html" class="title">Aych</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>
</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="../modules/_core_aych_.html">core/Aych</a>
</li>
<li>
<a href="_core_aych_.aych.html">Aych</a>
</li>
</ul>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-3 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation outline primary">
<a style="margin-left:0em" href="../globals.html">Globals</a>
<ul style="display:none">
{"Library":{"H":"_h_","Aych":"classes/_core_aych_.aych"},"Core":{"Piper":"classes/_core_piper_.piper","Renderable":"classes/_core_renderable_.renderable","StringLiteral":"classes/_core_stringliteral_.stringliteral"},"Elements":{"Element":"classes/_elements_element_.element","EmptyElement":"classes/_elements_emptyelement_.emptyelement","NestableElement":"classes/_elements_nestableelement_.nestableelement"},"Interfaces":{"Attributes":"interfaces/_interfaces_attributes_.attributes","RenderOptions":"interfaces/_interfaces_render_options_.renderoptions","SimpleObject":"interfaces/_interfaces_simple_object_.simpleobject"},"Structural":{"Each":"classes/_structural_each_.each","If":"classes/_structural_if_.if","Switch":"classes/_structural_switch_.switch","Group":"classes/_structural_group_.group"}}
</ul>
</nav>
</div>
<div class="col-7 offset-3 col-content">
<h1>Class Aych</h1>
<section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>The Aych class exposes all of the libraries features in an encapsulated package.</p>
</div>
</div></section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Aych</span>
</li>
</ul>
</section>
<section class="tsd-panel tsd-kind-class tsd-parent-kind-module">
<h3 class="tsd-before-signature">Indexable</h3>
<div class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">[</span>dynamicProperty: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">function</span></div>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>The Aych class exposes all of the libraries features in an encapsulated package.</p>
</div>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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-symbol">: </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<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>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a></h4>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Enumerations</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-enum tsd-parent-kind-class tsd-is-static"><a href="../enums/_core_aych_.aych.elementtype.html" class="tsd-kind-icon">ElementType</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><a href="_core_aych_.aych.html#piper" class="tsd-kind-icon">Piper</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="_core_aych_.aych.html#_" class="tsd-kind-icon">$</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_aych_.aych.html#_case" class="tsd-kind-icon">$case</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_aych_.aych.html#_each" class="tsd-kind-icon">$each</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_aych_.aych.html#_eachin" class="tsd-kind-icon">$eachIn</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_aych_.aych.html#_group" class="tsd-kind-icon">$group</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_aych_.aych.html#_if" class="tsd-kind-icon">$if</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_aych_.aych.html#_repeat" class="tsd-kind-icon">$repeat</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_aych_.aych.html#_switch" class="tsd-kind-icon">$switch</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_aych_.aych.html#string" class="tsd-kind-icon">string</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_core_aych_.aych.html#unescaped" class="tsd-kind-icon">unescaped</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_core_aych_.aych.html#compose" class="tsd-kind-icon">compose</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_core_aych_.aych.html#create" class="tsd-kind-icon">create</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_core_aych_.aych.html#destroy" class="tsd-kind-icon">destroy</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a name="piper" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> Piper</h3>
<div class="tsd-signature tsd-kind-icon">Piper<span class="tsd-signature-symbol">:</span> <a href="_core_piper_.piper.html" class="tsd-signature-type">Piper</a><span class="tsd-signature-symbol"> = Piper</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:198</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Exported Piper</p>
</div>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="_" class="tsd-anchor"></a>
<h3>$</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">$<span class="tsd-signature-symbol">(</span>scope<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span>, data<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_interfaces_simple_object_.simpleobject.html" class="tsd-signature-type">SimpleObject</a>, render<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:108</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Scopes Aych</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>scope: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>self<span class="tsd-signature-symbol">: </span><a href="_core_aych_.aych.html" class="tsd-signature-type">Aych</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>self: <a href="_core_aych_.aych.html" class="tsd-signature-type">Aych</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">string</span>
<span class="tsd-signature-symbol"> | </span>
<a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a>
</h4>
</li>
</ul>
</li>
</ul>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> data: <a href="../interfaces/_interfaces_simple_object_.simpleobject.html" class="tsd-signature-type">SimpleObject</a><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> render: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span>
<span class="tsd-signature-symbol"> | </span>
<span class="tsd-signature-type">string</span>
<span class="tsd-signature-symbol"> | </span>
<a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a>
</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="_case" class="tsd-anchor"></a>
<h3>$case</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">$case<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../modules/_structural_switch_.html#switchable" class="tsd-signature-type">Switchable</a>, renderable<span class="tsd-signature-symbol">: </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><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><a href="_structural_switch_.switch.case.html" class="tsd-signature-type">Case</a><span class="tsd-signature-symbol"><</span><a href="../modules/_structural_switch_.html#switchable" class="tsd-signature-type">Switchable</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:187</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>A case for the switch statements.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <a href="../modules/_structural_switch_.html#switchable" class="tsd-signature-type">Switchable</a></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The value determines which cases is chosen and rendered.</p>
</div>
</li>
<li>
<h5>renderable: <a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The renderable associated with this case.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_structural_switch_.switch.case.html" class="tsd-signature-type">Case</a><span class="tsd-signature-symbol"><</span><a href="../modules/_structural_switch_.html#switchable" class="tsd-signature-type">Switchable</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="_each" class="tsd-anchor"></a>
<h3>$each</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">$each<span class="tsd-signature-symbol">(</span>items<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, renderable<span class="tsd-signature-symbol">: </span><a href="../modules/_structural_each_.html#eachrenderfunction" class="tsd-signature-type">EachRenderFunction</a><span class="tsd-signature-symbol"> | </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, indexName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, itemName<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">undefined</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><a href="_structural_each_.each.html" class="tsd-signature-type">Each</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:128</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Renders a renderable for each item in a list.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>items: <span class="tsd-signature-type">Iterable</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The items used to iterate through.</p>
</div>
</li>
<li>
<h5>renderable: <a href="../modules/_structural_each_.html#eachrenderfunction" class="tsd-signature-type">EachRenderFunction</a><span class="tsd-signature-symbol"> | </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> indexName: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The index name used for the template string for each renderable.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> itemName: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The item name used for the template string for each renderable.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_structural_each_.each.html" class="tsd-signature-type">Each</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="_eachin" class="tsd-anchor"></a>
<h3>$each<wbr>In</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">$each<wbr>In<span class="tsd-signature-symbol">(</span>items<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_simple_object_.simpleobject.html" class="tsd-signature-type">SimpleObject</a>, renderable<span class="tsd-signature-symbol">: </span><a href="../modules/_structural_each_.html#eachrenderfunction" class="tsd-signature-type">EachRenderFunction</a><span class="tsd-signature-symbol"> | </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><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><a href="_structural_each_.each.html" class="tsd-signature-type">Each</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:137</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Renders a renderable for each key/value pair in an object.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>items: <a href="../interfaces/_interfaces_simple_object_.simpleobject.html" class="tsd-signature-type">SimpleObject</a></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>An object to iterate through.</p>
</div>
</li>
<li>
<h5>renderable: <a href="../modules/_structural_each_.html#eachrenderfunction" class="tsd-signature-type">EachRenderFunction</a><span class="tsd-signature-symbol"> | </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The renderable to iterate.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_structural_each_.each.html" class="tsd-signature-type">Each</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="_group" class="tsd-anchor"></a>
<h3>$group</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">$group<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>members<span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_structural_group_.group.html" class="tsd-signature-type">Group</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:154</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Renders a set of Renderable one after another.</p>
</div>
</div>
<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>members: <span class="tsd-signature-symbol">(</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>A set of one or more members to add to the group.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_structural_group_.group.html" class="tsd-signature-type">Group</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="_if" class="tsd-anchor"></a>
<h3>$if</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">$if<span class="tsd-signature-symbol">(</span>condition<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span>, ifRenderable<span class="tsd-signature-symbol">: </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span>, elseRenderable<span class="tsd-signature-symbol">?: </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><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><a href="_structural_if_.if.html" class="tsd-signature-type">If</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:164</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Renders a Renderable based on a condition.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>condition: <span class="tsd-signature-type">boolean</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The condition that determines if the renderable gets rendered.</p>
</div>
</li>
<li>
<h5>ifRenderable: <a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> elseRenderable: <a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_structural_if_.if.html" class="tsd-signature-type">If</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="_repeat" class="tsd-anchor"></a>
<h3>$repeat</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">$repeat<span class="tsd-signature-symbol">(</span>times<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, renderable<span class="tsd-signature-symbol">: </span><a href="../modules/_structural_each_.html#eachrenderfunction" class="tsd-signature-type">EachRenderFunction</a><span class="tsd-signature-symbol"> | </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><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><a href="_structural_each_.each.html" class="tsd-signature-type">Each</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:146</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Renders a renderable x number of times.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>times: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>Number of times to render.</p>
</div>
</li>
<li>
<h5>renderable: <a href="../modules/_structural_each_.html#eachrenderfunction" class="tsd-signature-type">EachRenderFunction</a><span class="tsd-signature-symbol"> | </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The renderable to render.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_structural_each_.each.html" class="tsd-signature-type">Each</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="_switch" class="tsd-anchor"></a>
<h3>$switch</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">$switch<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><a href="../modules/_structural_switch_.html#switchable" class="tsd-signature-type">Switchable</a>, <span class="tsd-signature-symbol">...</span>cases<span class="tsd-signature-symbol">: </span><a href="_structural_switch_.switch.case.html" class="tsd-signature-type">Case</a><span class="tsd-signature-symbol"><</span><a href="../modules/_structural_switch_.html#switchable" class="tsd-signature-type">Switchable</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_structural_switch_.switch.html" class="tsd-signature-type">Switch</a><span class="tsd-signature-symbol"><</span><a href="../modules/_structural_switch_.html#switchable" class="tsd-signature-type">Switchable</a><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:173</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Renders one out of one or more renderable based on the value of the switch.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>value: <a href="../modules/_structural_switch_.html#switchable" class="tsd-signature-type">Switchable</a></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The value determines which cases is chosen and rendered.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagRest">Rest</span> <span class="tsd-signature-symbol">...</span>cases: <a href="_structural_switch_.switch.case.html" class="tsd-signature-type">Case</a><span class="tsd-signature-symbol"><</span><a href="../modules/_structural_switch_.html#switchable" class="tsd-signature-type">Switchable</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>A set of cases with a value associated to it.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_structural_switch_.switch.html" class="tsd-signature-type">Switch</a><span class="tsd-signature-symbol"><</span><a href="../modules/_structural_switch_.html#switchable" class="tsd-signature-type">Switchable</a><span class="tsd-signature-symbol">></span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="string" class="tsd-anchor"></a>
<h3>string</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">string<span class="tsd-signature-symbol">(</span>str<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><a href="_core_stringliteral_.stringliteral.html" class="tsd-signature-type">StringLiteral</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:86</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Converts a javascript string literal into an Aych StringLiteral.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>str: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The string literal to convert.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_core_stringliteral_.stringliteral.html" class="tsd-signature-type">StringLiteral</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="unescaped" class="tsd-anchor"></a>
<h3>unescaped</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">unescaped<span class="tsd-signature-symbol">(</span>str<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><a href="_core_stringliteral_.stringliteral.html" class="tsd-signature-type">StringLiteral</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:97</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Converts a javascript string literal into an unescaped StringLiteral.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>str: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The string literal to convert.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_core_stringliteral_.stringliteral.html" class="tsd-signature-type">StringLiteral</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="compose" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> compose</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">compose<span class="tsd-signature-symbol">(</span>name<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, composition<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">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:74</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Defines a method on Aych that when called returns back a Renderable. These are
known as composables.</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 tsd-comment-text">
<p>Name of the composable.</p>
</div>
</li>
<li>
<h5>composition: <span class="tsd-signature-type">function</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The method that the defines what arguments the composable takes
and which renderable it returns.</p>
</div>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">...</span>args<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-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<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>args: <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">[]</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span>
<span class="tsd-signature-symbol"> | </span>
<a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a>
</h4>
</li>
</ul>
</li>
</ul>
</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 tsd-is-static">
<a name="create" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> create</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>tagName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, elType<span class="tsd-signature-symbol">: </span><a href="../enums/_core_aych_.aych.elementtype.html" class="tsd-signature-type">ElementType</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Aych.ts:30</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Factory for creating element factories.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>tagName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The name of the tag that is used.</p>
</div>
</li>
<li>
<h5>elType: <a href="../enums/_core_aych_.aych.elementtype.html" class="tsd-signature-type">ElementType</a></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The type of element to create.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="destroy" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> destroy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">destroy<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 core/Aych.ts:60</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Remove a created tag or composition.</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 tsd-comment-text">
<p>Name of the tag or composition.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
<!--{"options":"typedoc.json","tsconfig":"/Users/shawnholman/Desktop/Aych","inputFiles":["./src"],"mode":1,"includeDeclarations":false,"entryPoint":"","exclude":[],"externalPattern":[],"excludeExternals":true,"excludeNotExported":true,"excludeNotDocumented":false,"excludePrivate":true,"excludeProtected":false,"ignoreCompilerErrors":false,"disableSources":false,"includes":"","media":"","out":"./docs","json":"","theme":"node_modules/typedoc-neo-theme/bin/default","name":"Aych","includeVersion":false,"excludeTags":[],"readme":"DOCUMENTATION.md","defaultCategory":"Other","categoryOrder":[],"categorizeByGroup":true,"gitRevision":"","gitRemote":"origin","gaID":"","gaSite":"auto","hideGenerator":false,"toc":[],"disableOutputCheck":false,"help":false,"version":false,"plugin":["typedoc-neo-theme"],"logger":"console","listInvalidSymbolLinks":false,"outline":[{"Library":{"H":"_h_","Aych":"classes/_core_aych_.aych"},"Core":{"Piper":"classes/_core_piper_.piper","Renderable":"classes/_core_renderable_.renderable","StringLiteral":"classes/_core_stringliteral_.stringliteral"},"Elements":{"Element":"classes/_elements_element_.element","EmptyElement":"classes/_elements_emptyelement_.emptyelement","NestableElement":"classes/_elements_nestableelement_.nestableelement"},"Interfaces":{"Attributes":"interfaces/_interfaces_attributes_.attributes","RenderOptions":"interfaces/_interfaces_render_options_.renderoptions","SimpleObject":"interfaces/_interfaces_simple_object_.simpleobject"},"Structural":{"Each":"classes/_structural_each_.each","If":"classes/_structural_if_.if","Switch":"classes/_structural_switch_.switch","Group":"classes/_structural_group_.group"}}]}-->
</div>
<div class="col-2 col-menu secondary-menu">
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-module root">
<a href="_core_aych_.aych.html" class="tsd-kind-icon">Aych</a>
<ul>
<li class=" tsd-kind-enum tsd-parent-kind-class tsd-is-static">
<a href="../enums/_core_aych_.aych.elementtype.html" class="tsd-kind-icon">Element<wbr>Type</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-static">
<a href="_core_aych_.aych.html#piper" class="tsd-kind-icon">Piper</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_core_aych_.aych.html#_" class="tsd-kind-icon">$</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_core_aych_.aych.html#_case" class="tsd-kind-icon">$case</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_core_aych_.aych.html#_each" class="tsd-kind-icon">$each</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_core_aych_.aych.html#_eachin" class="tsd-kind-icon">$each<wbr>In</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_core_aych_.aych.html#_group" class="tsd-kind-icon">$group</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_core_aych_.aych.html#_if" class="tsd-kind-icon">$if</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_core_aych_.aych.html#_repeat" class="tsd-kind-icon">$repeat</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_core_aych_.aych.html#_switch" class="tsd-kind-icon">$switch</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_core_aych_.aych.html#string" class="tsd-kind-icon">string</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_core_aych_.aych.html#unescaped" class="tsd-kind-icon">unescaped</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_core_aych_.aych.html#compose" class="tsd-kind-icon">compose</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_core_aych_.aych.html#create" class="tsd-kind-icon">create</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_core_aych_.aych.html#destroy" class="tsd-kind-icon">destroy</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
</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>