docs/classes/_structural_each_.each.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Each | 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/_structural_each_.html">structural/Each</a>
</li>
<li>
<a href="_structural_each_.each.html">Each</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 Each</h1>
<section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>The Each class renders a renderable for each item in a list.</p>
</div>
</div></section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a>
<ul class="tsd-hierarchy">
<li>
<span class="target">Each</span>
</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>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_structural_each_.each.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="_structural_each_.each.html#templates" class="tsd-kind-icon">templates</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-inherited">
<h3>Accessors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited"><a href="_structural_each_.each.html#r" class="tsd-kind-icon">r</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_structural_each_.each.html#append" class="tsd-kind-icon">append</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_structural_each_.each.html#empty" class="tsd-kind-icon">empty</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected"><a href="_structural_each_.each.html#internalrender" class="tsd-kind-icon">internalRender</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_structural_each_.each.html#render" class="tsd-kind-icon">render</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_structural_each_.each.html#setindexname" class="tsd-kind-icon">setIndexName</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_structural_each_.each.html#setitemname" class="tsd-kind-icon">setItemName</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_structural_each_.each.html#tostring" class="tsd-kind-icon">toString</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_structural_each_.each.html#when" class="tsd-kind-icon">when</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="_structural_each_.each.html#with" class="tsd-kind-icon">with</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>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>, toRender<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">string</span>, itemName<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 structural/Each.ts:18</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Construct the each statement</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-shorttext">
<div class="lead">
<p>The items used to iterate through.</p>
</div>
</div>
</li>
<li>
<h5>toRender: <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-shorttext">
<div class="lead">
<p>The renderable to create for each item.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> indexName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "i"</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>The index name used for the template string for each renderable.</p>
</div>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> itemName: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = "item"</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>The item name used for the template string for each renderable.</p>
</div>
</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>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a name="templates" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> templates</h3>
<div class="tsd-signature tsd-kind-icon">templates<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_interfaces_simple_object_.simpleobject.html" class="tsd-signature-type">SimpleObject</a></div>
<aside class="tsd-sources">
<p>Inherited from <a href="_core_renderable_.renderable.html">Renderable</a>.<a href="_core_renderable_.renderable.html#templates">templates</a></p>
<ul>
<li>Defined in core/Renderable.ts:12</li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
<h2>Accessors</h2>
<section class="tsd-panel tsd-member tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a name="r" class="tsd-anchor"></a>
<h3>r</h3>
<ul class="tsd-signatures tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">get</span> r<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_core_renderable_.renderable.html">Renderable</a>.<a href="_core_renderable_.renderable.html#r">r</a></p>
<ul>
<li>Defined in core/Renderable.ts:62</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Getting for the HTML returned by the render function.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="append" class="tsd-anchor"></a>
<h3>append</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">append<span class="tsd-signature-symbol">(</span>templates<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_simple_object_.simpleobject.html" class="tsd-signature-type">SimpleObject</a>, prioritize<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><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">
<p>Inherited from <a href="_core_renderable_.renderable.html">Renderable</a>.<a href="_core_renderable_.renderable.html#append">append</a></p>
<ul>
<li>Defined in core/Renderable.ts:42</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Appends templates to the existing templates object.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>templates: <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>Key-value pairs that map to a template rendered in StringLiteral's</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagDefault value">Default value</span> prioritize: <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>Whether or not to allow appended templates to override existing template properties</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <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="empty" class="tsd-anchor"></a>
<h3>empty</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">empty<span class="tsd-signature-symbol">(</span>toRender<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 structural/Each.ts:46</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Sets the empty renderable which gets used if the list is empty.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>toRender: <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 default renderable if the list is empty.</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 tsd-is-overwrite tsd-is-protected">
<a name="internalrender" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> internal<wbr>Render</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">internal<wbr>Render<span class="tsd-signature-symbol">(</span>templates<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_simple_object_.simpleobject.html" class="tsd-signature-type">SimpleObject</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">
<p>Overrides <a href="_core_renderable_.renderable.html">Renderable</a>.<a href="_core_renderable_.renderable.html#internalrender">internalRender</a></p>
<ul>
<li>Defined in structural/Each.ts:70</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-tags">
<dl class="tsd-comment-tags"><dt>inheritdoc</dt>
<dd></dd></dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>templates: <a href="../interfaces/_interfaces_simple_object_.simpleobject.html" class="tsd-signature-type">SimpleObject</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a name="render" class="tsd-anchor"></a>
<h3>render</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">render<span class="tsd-signature-symbol">(</span>templates<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_interfaces_simple_object_.simpleobject.html" class="tsd-signature-type">SimpleObject</a>, options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_interfaces_render_options_.renderoptions.html" class="tsd-signature-type">RenderOptions</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">
<p>Inherited from <a href="_core_renderable_.renderable.html">Renderable</a>.<a href="_core_renderable_.renderable.html#render">render</a></p>
<ul>
<li>Defined in core/Renderable.ts:52</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Renders the internalRender function.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> templates: <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>Templates to pass in</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> options: <a href="../interfaces/_interfaces_render_options_.renderoptions.html" class="tsd-signature-type">RenderOptions</a></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>Render options</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">
<a name="setindexname" class="tsd-anchor"></a>
<h3>set<wbr>Index<wbr>Name</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Index<wbr>Name<span class="tsd-signature-symbol">(</span>indexName<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 structural/Each.ts:55</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Sets the index variable name used for the template generated by the each method.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>indexName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The new index name.</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="setitemname" class="tsd-anchor"></a>
<h3>set<wbr>Item<wbr>Name</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">set<wbr>Item<wbr>Name<span class="tsd-signature-symbol">(</span>itemName<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 structural/Each.ts:64</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Sets the item variable name used for the template generated by the each method.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>itemName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The new item name.</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 tsd-is-inherited">
<a name="tostring" class="tsd-anchor"></a>
<h3>to<wbr>String</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">to<wbr>String<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Inherited from <a href="_core_renderable_.renderable.html">Renderable</a>.<a href="_core_renderable_.renderable.html#tostring">toString</a></p>
<ul>
<li>Defined in core/Renderable.ts:70</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Overrides the toString method called by JavaScript when
string concatenate occurs</p>
</div>
</div>
<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-inherited">
<a name="when" class="tsd-anchor"></a>
<h3>when</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">when<span class="tsd-signature-symbol">(</span>condition<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><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">
<p>Inherited from <a href="_core_renderable_.renderable.html">Renderable</a>.<a href="_core_renderable_.renderable.html#when">when</a></p>
<ul>
<li>Defined in core/Renderable.ts:32</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Turn on and off the ability for this element to render</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 whether or not the element can render.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <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 tsd-is-inherited">
<a name="with" class="tsd-anchor"></a>
<h3>with</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<li class="tsd-signature tsd-kind-icon">with<span class="tsd-signature-symbol">(</span>templates<span class="tsd-signature-symbol">: </span><a href="../interfaces/_interfaces_simple_object_.simpleobject.html" class="tsd-signature-type">SimpleObject</a><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">
<aside class="tsd-sources">
<p>Inherited from <a href="_core_renderable_.renderable.html">Renderable</a>.<a href="_core_renderable_.renderable.html#with">with</a></p>
<ul>
<li>Defined in core/Renderable.ts:23</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Sets the templates.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>templates: <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>Key-value pairs that map to a template rendered in StringLiteral's</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_core_renderable_.renderable.html" class="tsd-signature-type">Renderable</a></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="_structural_each_.each.html" class="tsd-kind-icon">Each</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_structural_each_.each.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
<a href="_structural_each_.each.html#templates" class="tsd-kind-icon">templates</a>
</li>
<li class=" tsd-kind-get-signature tsd-parent-kind-class tsd-is-inherited">
<a href="_structural_each_.each.html#r" class="tsd-kind-icon">r</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_structural_each_.each.html#append" class="tsd-kind-icon">append</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_structural_each_.each.html#empty" class="tsd-kind-icon">empty</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-protected">
<a href="_structural_each_.each.html#internalrender" class="tsd-kind-icon">internal<wbr>Render</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_structural_each_.each.html#render" class="tsd-kind-icon">render</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_structural_each_.each.html#setindexname" class="tsd-kind-icon">set<wbr>Index<wbr>Name</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_structural_each_.each.html#setitemname" class="tsd-kind-icon">set<wbr>Item<wbr>Name</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_structural_each_.each.html#tostring" class="tsd-kind-icon">to<wbr>String</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_structural_each_.each.html#when" class="tsd-kind-icon">when</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
<a href="_structural_each_.each.html#with" class="tsd-kind-icon">with</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-type-alias tsd-parent-kind-module root">
<a href="../modules/_structural_each_.html#eachrenderfunction" class="tsd-kind-icon">Each<wbr>Render<wbr>Function</a>
</li>
</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>