Sign upLogin

shawnholman/Aych

View on GitHub
Star
docs/modules/_util_.html

Summary

Maintainability
Test Coverage
<!doctype html>
<html class="default no-js">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <title>Util | 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="_util_.html">Util</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">
                    {&quot;Library&quot;:{&quot;H&quot;:&quot;_h_&quot;,&quot;Aych&quot;:&quot;classes/_core_aych_.aych&quot;},&quot;Core&quot;:{&quot;Piper&quot;:&quot;classes/_core_piper_.piper&quot;,&quot;Renderable&quot;:&quot;classes/_core_renderable_.renderable&quot;,&quot;StringLiteral&quot;:&quot;classes/_core_stringliteral_.stringliteral&quot;},&quot;Elements&quot;:{&quot;Element&quot;:&quot;classes/_elements_element_.element&quot;,&quot;EmptyElement&quot;:&quot;classes/_elements_emptyelement_.emptyelement&quot;,&quot;NestableElement&quot;:&quot;classes/_elements_nestableelement_.nestableelement&quot;},&quot;Interfaces&quot;:{&quot;Attributes&quot;:&quot;interfaces/_interfaces_attributes_.attributes&quot;,&quot;RenderOptions&quot;:&quot;interfaces/_interfaces_render_options_.renderoptions&quot;,&quot;SimpleObject&quot;:&quot;interfaces/_interfaces_simple_object_.simpleobject&quot;},&quot;Structural&quot;:{&quot;Each&quot;:&quot;classes/_structural_each_.each&quot;,&quot;If&quot;:&quot;classes/_structural_if_.if&quot;,&quot;Switch&quot;:&quot;classes/_structural_switch_.switch&quot;,&quot;Group&quot;:&quot;classes/_structural_group_.group&quot;}}
                </ul>
            </nav>
        </div>
        <div class="col-7 offset-3 col-content">
            <h1>Module Util</h1>
            <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>Functions</h3>
                            <ul class="tsd-index-list">
                                <li class="tsd-kind-function tsd-parent-kind-module"><a href="_util_.html#isattributes" class="tsd-kind-icon">isAttributes</a></li>
                                <li class="tsd-kind-function tsd-parent-kind-module"><a href="_util_.html#isrenderable" class="tsd-kind-icon">isRenderable</a></li>
                                <li class="tsd-kind-function tsd-parent-kind-module"><a href="_util_.html#isstring" class="tsd-kind-icon">isString</a></li>
                                <li class="tsd-kind-function tsd-parent-kind-module"><a href="_util_.html#kebabtocamelcase" class="tsd-kind-icon">kebabToCamelCase</a></li>
                                <li class="tsd-kind-function tsd-parent-kind-module"><a href="_util_.html#merge" class="tsd-kind-icon">merge</a></li>
                                <li class="tsd-kind-function tsd-parent-kind-module"><a href="_util_.html#removespaces" class="tsd-kind-icon">removeSpaces</a></li>
                            </ul>
                        </section>
                    </div>
                </section>
            </section>
            <section class="tsd-panel-group tsd-member-group ">
                <h2>Functions</h2>
                <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
                    <a name="isattributes" class="tsd-anchor"></a>
                    <h3>is<wbr>Attributes</h3>
                    <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
                        <li class="tsd-signature tsd-kind-icon">is<wbr>Attributes<span class="tsd-signature-symbol">(</span>param<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-type">param</span></li>
                    </ul>
                    <ul class="tsd-descriptions">
                        <li class="tsd-description">
                            <aside class="tsd-sources">
                                <ul>
                                    <li>Defined in Util.ts:25</li>
                                </ul>
                            </aside>
                            <div class="tsd-comment tsd-typography tsd-comment-shorttext">
                                <div class="lead">
                                    <p>s
                                        Determines if parameter is a Attributes based on the historic assumption that anything
                                    not a string or renderable is an Attributes.</p>
                                </div>
                            </div>
                            <h4 class="tsd-parameters-title">Parameters</h4>
                            <ul class="tsd-parameters">
                                <li>
                                    <h5><span class="tsd-flag ts-flagOptional">Optional</span> param: <span class="tsd-signature-type">any</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">param</span></h4>
                        </li>
                    </ul>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
                    <a name="isrenderable" class="tsd-anchor"></a>
                    <h3>is<wbr>Renderable</h3>
                    <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
                        <li class="tsd-signature tsd-kind-icon">is<wbr>Renderable<span class="tsd-signature-symbol">(</span>param<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-type">param</span></li>
                    </ul>
                    <ul class="tsd-descriptions">
                        <li class="tsd-description">
                            <aside class="tsd-sources">
                                <ul>
                                    <li>Defined in Util.ts:8</li>
                                </ul>
                            </aside>
                            <div class="tsd-comment tsd-typography tsd-comment-shorttext">
                                <div class="lead">
                                    <p>Determines if parameter is a Renderable.</p>
                                </div>
                            </div>
                            <h4 class="tsd-parameters-title">Parameters</h4>
                            <ul class="tsd-parameters">
                                <li>
                                    <h5><span class="tsd-flag ts-flagOptional">Optional</span> param: <span class="tsd-signature-type">any</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">param</span></h4>
                        </li>
                    </ul>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
                    <a name="isstring" class="tsd-anchor"></a>
                    <h3>is<wbr>String</h3>
                    <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
                        <li class="tsd-signature tsd-kind-icon">is<wbr>String<span class="tsd-signature-symbol">(</span>param<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-type">param</span></li>
                    </ul>
                    <ul class="tsd-descriptions">
                        <li class="tsd-description">
                            <aside class="tsd-sources">
                                <ul>
                                    <li>Defined in Util.ts:16</li>
                                </ul>
                            </aside>
                            <div class="tsd-comment tsd-typography tsd-comment-shorttext">
                                <div class="lead">
                                    <p>Determines if parameter is a a string.</p>
                                </div>
                            </div>
                            <h4 class="tsd-parameters-title">Parameters</h4>
                            <ul class="tsd-parameters">
                                <li>
                                    <h5><span class="tsd-flag ts-flagOptional">Optional</span> param: <span class="tsd-signature-type">any</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">param</span></h4>
                        </li>
                    </ul>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
                    <a name="kebabtocamelcase" class="tsd-anchor"></a>
                    <h3>kebab<wbr>ToCamel<wbr>Case</h3>
                    <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
                        <li class="tsd-signature tsd-kind-icon">kebab<wbr>ToCamel<wbr>Case<span class="tsd-signature-symbol">(</span>str<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 Util.ts:42</li>
                                </ul>
                            </aside>
                            <div class="tsd-comment tsd-typography tsd-comment-shorttext">
                                <div class="lead">
                                    <p>Converts kebab case into camel case.</p>
                                </div>
                            </div>
                            <h4 class="tsd-parameters-title">Parameters</h4>
                            <ul class="tsd-parameters">
                                <li>
                                    <h5>str: <span class="tsd-signature-type">string</span></h5>
                                    <div class="tsd-comment tsd-typography tsd-comment-text">
                                        <p>String to convert.</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-function tsd-parent-kind-module">
                    <a name="merge" class="tsd-anchor"></a>
                    <h3>merge</h3>
                    <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
                        <li class="tsd-signature tsd-kind-icon">merge<span class="tsd-signature-symbol">(</span>priority<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_interfaces_simple_object_.simpleobject.html" class="tsd-signature-type">SimpleObject</a>, object<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">object</span></li>
                    </ul>
                    <ul class="tsd-descriptions">
                        <li class="tsd-description">
                            <aside class="tsd-sources">
                                <ul>
                                    <li>Defined in Util.ts:34</li>
                                </ul>
                            </aside>
                            <div class="tsd-comment tsd-typography tsd-comment-shorttext">
                                <div class="lead">
                                    <p>Merges two simple objects together.</p>
                                </div>
                            </div>
                            <h4 class="tsd-parameters-title">Parameters</h4>
                            <ul class="tsd-parameters">
                                <li>
                                    <h5><span class="tsd-flag ts-flagOptional">Optional</span> priority: <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>The priority object will not have any of its properties overriden.</p>
                                    </div>
                                </li>
                                <li>
                                    <h5><span class="tsd-flag ts-flagOptional">Optional</span> object: <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>Priority will get merged into this object.</p>
                                    </div>
                                </li>
                            </ul>
                            <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
                            <ul class="tsd-parameters">
                            </ul>
                        </li>
                    </ul>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
                    <a name="removespaces" class="tsd-anchor"></a>
                    <h3>remove<wbr>Spaces</h3>
                    <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
                        <li class="tsd-signature tsd-kind-icon">remove<wbr>Spaces<span class="tsd-signature-symbol">(</span>str<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 Util.ts:50</li>
                                </ul>
                            </aside>
                            <div class="tsd-comment tsd-typography tsd-comment-shorttext">
                                <div class="lead">
                                    <p>Removes unnecessary spaces and new lines from a string.</p>
                                </div>
                            </div>
                            <h4 class="tsd-parameters-title">Parameters</h4>
                            <ul class="tsd-parameters">
                                <li>
                                    <h5>str: <span class="tsd-signature-type">string</span></h5>
                                    <div class="tsd-comment tsd-typography tsd-comment-text">
                                        <p>The string to remove spaces from.</p>
                                    </div>
                                </li>
                            </ul>
                            <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
                        </li>
                    </ul>
                </section>
            </section>
            <!--{&quot;options&quot;:&quot;typedoc.json&quot;,&quot;tsconfig&quot;:&quot;/Users/shawnholman/Desktop/Aych&quot;,&quot;inputFiles&quot;:[&quot;./src&quot;],&quot;mode&quot;:1,&quot;includeDeclarations&quot;:false,&quot;entryPoint&quot;:&quot;&quot;,&quot;exclude&quot;:[],&quot;externalPattern&quot;:[],&quot;excludeExternals&quot;:true,&quot;excludeNotExported&quot;:true,&quot;excludeNotDocumented&quot;:false,&quot;excludePrivate&quot;:true,&quot;excludeProtected&quot;:false,&quot;ignoreCompilerErrors&quot;:false,&quot;disableSources&quot;:false,&quot;includes&quot;:&quot;&quot;,&quot;media&quot;:&quot;&quot;,&quot;out&quot;:&quot;./docs&quot;,&quot;json&quot;:&quot;&quot;,&quot;theme&quot;:&quot;node_modules/typedoc-neo-theme/bin/default&quot;,&quot;name&quot;:&quot;Aych&quot;,&quot;includeVersion&quot;:false,&quot;excludeTags&quot;:[],&quot;readme&quot;:&quot;DOCUMENTATION.md&quot;,&quot;defaultCategory&quot;:&quot;Other&quot;,&quot;categoryOrder&quot;:[],&quot;categorizeByGroup&quot;:true,&quot;gitRevision&quot;:&quot;&quot;,&quot;gitRemote&quot;:&quot;origin&quot;,&quot;gaID&quot;:&quot;&quot;,&quot;gaSite&quot;:&quot;auto&quot;,&quot;hideGenerator&quot;:false,&quot;toc&quot;:[],&quot;disableOutputCheck&quot;:false,&quot;help&quot;:false,&quot;version&quot;:false,&quot;plugin&quot;:[&quot;typedoc-neo-theme&quot;],&quot;logger&quot;:&quot;console&quot;,&quot;listInvalidSymbolLinks&quot;:false,&quot;outline&quot;:[{&quot;Library&quot;:{&quot;H&quot;:&quot;_h_&quot;,&quot;Aych&quot;:&quot;classes/_core_aych_.aych&quot;},&quot;Core&quot;:{&quot;Piper&quot;:&quot;classes/_core_piper_.piper&quot;,&quot;Renderable&quot;:&quot;classes/_core_renderable_.renderable&quot;,&quot;StringLiteral&quot;:&quot;classes/_core_stringliteral_.stringliteral&quot;},&quot;Elements&quot;:{&quot;Element&quot;:&quot;classes/_elements_element_.element&quot;,&quot;EmptyElement&quot;:&quot;classes/_elements_emptyelement_.emptyelement&quot;,&quot;NestableElement&quot;:&quot;classes/_elements_nestableelement_.nestableelement&quot;},&quot;Interfaces&quot;:{&quot;Attributes&quot;:&quot;interfaces/_interfaces_attributes_.attributes&quot;,&quot;RenderOptions&quot;:&quot;interfaces/_interfaces_render_options_.renderoptions&quot;,&quot;SimpleObject&quot;:&quot;interfaces/_interfaces_simple_object_.simpleobject&quot;},&quot;Structural&quot;:{&quot;Each&quot;:&quot;classes/_structural_each_.each&quot;,&quot;If&quot;:&quot;classes/_structural_if_.if&quot;,&quot;Switch&quot;:&quot;classes/_structural_switch_.switch&quot;,&quot;Group&quot;:&quot;classes/_structural_group_.group&quot;}}]}-->
        </div>
        <div class="col-2 col-menu secondary-menu">
            <nav class="tsd-navigation secondary menu-sticky">
                <ul class="before-current">
                    <li class=" tsd-kind-function tsd-parent-kind-module root">
                        <a href="_util_.html#isattributes" class="tsd-kind-icon">is<wbr>Attributes</a>
                    </li>
                    <li class=" tsd-kind-function tsd-parent-kind-module root">
                        <a href="_util_.html#isrenderable" class="tsd-kind-icon">is<wbr>Renderable</a>
                    </li>
                    <li class=" tsd-kind-function tsd-parent-kind-module root">
                        <a href="_util_.html#isstring" class="tsd-kind-icon">is<wbr>String</a>
                    </li>
                    <li class=" tsd-kind-function tsd-parent-kind-module root">
                        <a href="_util_.html#kebabtocamelcase" class="tsd-kind-icon">kebab<wbr>ToCamel<wbr>Case</a>
                    </li>
                    <li class=" tsd-kind-function tsd-parent-kind-module root">
                        <a href="_util_.html#merge" class="tsd-kind-icon">merge</a>
                    </li>
                    <li class=" tsd-kind-function tsd-parent-kind-module root">
                        <a href="_util_.html#removespaces" class="tsd-kind-icon">remove<wbr>Spaces</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>