docs/classes/_core_piper_.piper.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Piper | 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_piper_.html">core/Piper</a>
</li>
<li>
<a href="_core_piper_.piper.html">Piper</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 Piper</h1>
<section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Piper is the piping engine. Template pipes are defined and executed here.
TODO: Scope piper.</p>
</div>
</div></section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Piper</span>
</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>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_core_piper_.piper.html#copy" class="tsd-kind-icon">copy</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_core_piper_.piper.html#deregister" class="tsd-kind-icon">deregister</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_core_piper_.piper.html#pipe" class="tsd-kind-icon">pipe</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_core_piper_.piper.html#register" class="tsd-kind-icon">register</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="_core_piper_.piper.html#update" class="tsd-kind-icon">update</a></li>
</ul>
</section>
</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 tsd-is-static">
<a name="copy" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> copy</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">copy<span class="tsd-signature-symbol">(</span>pipeName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, newPipeName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PipeCopyFunc</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/Piper.ts:51</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Copies an existing pipe over to a new name.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pipeName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The name of the pipe to copy.</p>
</div>
</li>
<li>
<h5>newPipeName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The name of the new pipe to make from the copy.</p>
</div>
</li>
<li>
<h5>func: <span class="tsd-signature-type">PipeCopyFunc</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The update pipe function to build the update.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="deregister" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> deregister</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">deregister<span class="tsd-signature-symbol">(</span>pipeName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in core/Piper.ts:32</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Remove an existing pipe.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pipeName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The pipe to remove.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
<p>Whether or not the uninstall was a success.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="pipe" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> pipe</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">pipe<span class="tsd-signature-symbol">(</span>value<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, pipeName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, parameters<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><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/Piper.ts:67</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Pipes a string through the Aych piper.</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>pipeName: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> parameters: <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">
</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="register" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> register</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">register<span class="tsd-signature-symbol">(</span>pipeName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PipeFunc</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/Piper.ts:15</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Register a new pipe with piper.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pipeName: <span class="tsd-signature-type">string</span></h5>
</li>
<li>
<h5>func: <span class="tsd-signature-type">PipeFunc</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a name="update" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagStatic">Static</span> update</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static">
<li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>pipeName<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, func<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">PipeCopyFunc</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/Piper.ts:41</li>
</ul>
</aside>
<div class="tsd-comment tsd-typography tsd-comment-shorttext">
<div class="lead">
<p>Updates an existing pipe.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>pipeName: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The name of the pipe to update.</p>
</div>
</li>
<li>
<h5>func: <span class="tsd-signature-type">PipeCopyFunc</span></h5>
<div class="tsd-comment tsd-typography tsd-comment-text">
<p>The update pipe function to build the update.</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_piper_.piper.html" class="tsd-kind-icon">Piper</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_core_piper_.piper.html#copy" class="tsd-kind-icon">copy</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_core_piper_.piper.html#deregister" class="tsd-kind-icon">deregister</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_core_piper_.piper.html#pipe" class="tsd-kind-icon">pipe</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_core_piper_.piper.html#register" class="tsd-kind-icon">register</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-static">
<a href="_core_piper_.piper.html#update" class="tsd-kind-icon">update</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>