evrimfeyyaz/covid-19-api

View on GitHub
docs/modules/_utils_.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>&quot;utils&quot; | COVID-19 API - v2.0.5</title>
    <meta name="description" content="Documentation for COVID-19 API - v2.0.5">
    <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.json" data-base="..">
                    <div class="field">
                        <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
                        <input id="tsd-search-field" type="text" />
                    </div>
                    <ul class="results">
                        <li class="state loading">Preparing search index...</li>
                        <li class="state failure">The search index is not available</li>
                    </ul>
                    <a href="../index.html" class="title">COVID-19 API - v2.0.5</a>
                </div>
                <div class="table-cell" id="tsd-widgets">
                    <div id="tsd-filter">
                        <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
                        <div class="tsd-filter-group">
                            <div class="tsd-select" id="tsd-filter-visibility">
                                <span class="tsd-select-label">All</span>
                                <ul class="tsd-select-list">
                                    <li data-value="public">Public</li>
                                    <li data-value="protected">Public/Protected</li>
                                    <li data-value="private" class="selected">All</li>
                                </ul>
                            </div>
                            <input type="checkbox" id="tsd-filter-inherited" checked />
                            <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
                            <input type="checkbox" id="tsd-filter-externals" checked />
                            <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
                            <input type="checkbox" id="tsd-filter-only-exported" />
                            <label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
                        </div>
                    </div>
                    <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
                </div>
            </div>
        </div>
    </div>
    <div class="tsd-page-title">
        <div class="container">
            <ul class="tsd-breadcrumb">
                <li>
                    <a href="../globals.html">Globals</a>
                </li>
                <li>
                    <a href="_utils_.html">&quot;utils&quot;</a>
                </li>
            </ul>
            <h1>Module &quot;utils&quot;</h1>
        </div>
    </div>
</header>
<div class="container container-main">
    <div class="row">
        <div class="col-8 col-content">
            <section class="tsd-panel-group tsd-index-group">
                <h2>Index</h2>
                <section class="tsd-panel tsd-index-panel">
                    <div class="tsd-index-content">
                        <section class="tsd-index-section ">
                            <h3>Functions</h3>
                            <ul class="tsd-index-list">
                                <li class="tsd-kind-function tsd-parent-kind-module"><a href="_utils_.html#cloneinternallocationdata" class="tsd-kind-icon">clone<wbr>Internal<wbr>Location<wbr>Data</a></li>
                                <li class="tsd-kind-function tsd-parent-kind-module"><a href="_utils_.html#getfulllocationname" class="tsd-kind-icon">get<wbr>Full<wbr>Location<wbr>Name</a></li>
                                <li class="tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter"><a href="_utils_.html#pushunique" class="tsd-kind-icon">push<wbr>Unique</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="cloneinternallocationdata" class="tsd-anchor"></a>
                    <h3>clone<wbr>Internal<wbr>Location<wbr>Data</h3>
                    <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
                        <li class="tsd-signature tsd-kind-icon">clone<wbr>Internal<wbr>Location<wbr>Data<span class="tsd-signature-symbol">(</span>data<span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a></li>
                    </ul>
                    <ul class="tsd-descriptions">
                        <li class="tsd-description">
                            <aside class="tsd-sources">
                                <ul>
                                    <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/utils.ts#L42">src/utils.ts:42</a></li>
                                </ul>
                            </aside>
                            <h4 class="tsd-parameters-title">Parameters</h4>
                            <ul class="tsd-parameters">
                                <li>
                                    <h5>data: <a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a></h5>
                                </li>
                            </ul>
                            <h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a></h4>
                        </li>
                    </ul>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
                    <a name="getfulllocationname" class="tsd-anchor"></a>
                    <h3>get<wbr>Full<wbr>Location<wbr>Name</h3>
                    <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
                        <li class="tsd-signature tsd-kind-icon">get<wbr>Full<wbr>Location<wbr>Name<span class="tsd-signature-symbol">(</span>countryOrRegion<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, provinceOrState<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>, county<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 <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/utils.ts#L11">src/utils.ts:11</a></li>
                                </ul>
                            </aside>
                            <h4 class="tsd-parameters-title">Parameters</h4>
                            <ul class="tsd-parameters">
                                <li>
                                    <h5>countryOrRegion: <span class="tsd-signature-type">string</span></h5>
                                </li>
                                <li>
                                    <h5><span class="tsd-flag ts-flagOptional">Optional</span> provinceOrState: <span class="tsd-signature-type">undefined</span><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> county: <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></h5>
                                </li>
                            </ul>
                            <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
                        </li>
                    </ul>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
                    <a name="pushunique" class="tsd-anchor"></a>
                    <h3>push<wbr>Unique</h3>
                    <ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
                        <li class="tsd-signature tsd-kind-icon">push<wbr>Unique&lt;T&gt;<span class="tsd-signature-symbol">(</span>arr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span>, el<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
                    </ul>
                    <ul class="tsd-descriptions">
                        <li class="tsd-description">
                            <aside class="tsd-sources">
                                <ul>
                                    <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/utils.ts#L36">src/utils.ts:36</a></li>
                                </ul>
                            </aside>
                            <div class="tsd-comment tsd-typography">
                                <div class="lead">
                                    <p>Pushes an element into an array if the element doesn&#39;t already exist in the array.</p>
                                </div>
                            </div>
                            <h4 class="tsd-type-parameters-title">Type parameters</h4>
                            <ul class="tsd-type-parameters">
                                <li>
                                    <h4>T</h4>
                                </li>
                            </ul>
                            <h4 class="tsd-parameters-title">Parameters</h4>
                            <ul class="tsd-parameters">
                                <li>
                                    <h5>arr: <span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span></h5>
                                </li>
                                <li>
                                    <h5>el: <span class="tsd-signature-type">T</span></h5>
                                    <div class="tsd-comment tsd-typography">
                                    </div>
                                </li>
                            </ul>
                            <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
                        </li>
                    </ul>
                </section>
            </section>
        </div>
        <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
            <nav class="tsd-navigation primary">
                <ul>
                    <li class="globals  ">
                        <a href="../globals.html"><em>Globals</em></a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_covid19api_.html">&quot;COVID19API&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_covid19apierror_.html">&quot;COVID19APIError&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_datagetter_datagetter_.html">&quot;<wbr>Data<wbr>Getter/<wbr>Data<wbr>Getter&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_datagetter_filegetter_.html">&quot;<wbr>Data<wbr>Getter/<wbr>File<wbr>Getter&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_datagetter_githubgetter_.html">&quot;<wbr>Data<wbr>Getter/<wbr>Git<wbr>Hub<wbr>Getter&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_datastore_datastore_.html">&quot;<wbr>Data<wbr>Store/<wbr>Data<wbr>Store&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_datastore_indexeddbstore_.html">&quot;<wbr>Data<wbr>Store/<wbr>IndexedDBStore&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_datastore_memorystore_.html">&quot;<wbr>Data<wbr>Store/<wbr>Memory<wbr>Store&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_format_.html">&quot;format&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_index_.html">&quot;index&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_parse_.html">&quot;parse&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_types_.html">&quot;types&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_uslocations_.html">&quot;us<wbr>Locations&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="_usstates_.html">&quot;us<wbr>States&quot;</a>
                    </li>
                    <li class="current tsd-kind-module">
                        <a href="_utils_.html">&quot;utils&quot;</a>
                    </li>
                </ul>
            </nav>
            <nav class="tsd-navigation secondary menu-sticky">
                <ul class="before-current">
                    <li class=" tsd-kind-function tsd-parent-kind-module">
                        <a href="_utils_.html#cloneinternallocationdata" class="tsd-kind-icon">clone<wbr>Internal<wbr>Location<wbr>Data</a>
                    </li>
                    <li class=" tsd-kind-function tsd-parent-kind-module">
                        <a href="_utils_.html#getfulllocationname" class="tsd-kind-icon">get<wbr>Full<wbr>Location<wbr>Name</a>
                    </li>
                    <li class=" tsd-kind-function tsd-parent-kind-module tsd-has-type-parameter">
                        <a href="_utils_.html#pushunique" class="tsd-kind-icon">push<wbr>Unique</a>
                    </li>
                </ul>
            </nav>
        </div>
    </div>
</div>
<footer class="with-border-bottom">
    <div class="container">
        <h2>Legend</h2>
        <div class="tsd-legend-group">
            <ul class="tsd-legend">
                <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
                <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
                <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
                <li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
                <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
            </ul>
            <ul class="tsd-legend">
                <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
            </ul>
            <ul class="tsd-legend">
                <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
            </ul>
        </div>
    </div>
</footer>
<div class="container tsd-generator">
    <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>