evrimfeyyaz/covid-19-api

View on GitHub
docs/interfaces/_types_.locationinfo.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>LocationInfo | 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="../modules/_types_.html">&quot;types&quot;</a>
                </li>
                <li>
                    <a href="_types_.locationinfo.html">LocationInfo</a>
                </li>
            </ul>
            <h1>Interface LocationInfo</h1>
        </div>
    </div>
</header>
<div class="container container-main">
    <div class="row">
        <div class="col-8 col-content">
            <section class="tsd-panel tsd-comment">
                <div class="tsd-comment tsd-typography">
                    <div class="lead">
                        <p>Defines the structure of an object which contains the information on a certain location.</p>
                    </div>
                </div>
            </section>
            <section class="tsd-panel tsd-hierarchy">
                <h3>Hierarchy</h3>
                <ul class="tsd-hierarchy">
                    <li>
                        <span class="target">LocationInfo</span>
                        <ul class="tsd-hierarchy">
                            <li>
                                <a href="_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a>
                            </li>
                        </ul>
                    </li>
                </ul>
            </section>
            <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>Properties</h3>
                            <ul class="tsd-index-list">
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_.locationinfo.html#countryorregion" class="tsd-kind-icon">country<wbr>OrRegion</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_.locationinfo.html#county" class="tsd-kind-icon">county</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_.locationinfo.html#latitude" class="tsd-kind-icon">latitude</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_.locationinfo.html#location" class="tsd-kind-icon">location</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_.locationinfo.html#longitude" class="tsd-kind-icon">longitude</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_.locationinfo.html#provinceorstate" class="tsd-kind-icon">province<wbr>OrState</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-interface">
                    <a name="countryorregion" class="tsd-anchor"></a>
                    <h3>country<wbr>OrRegion</h3>
                    <div class="tsd-signature tsd-kind-icon">country<wbr>OrRegion<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L44">src/types.ts:44</a></li>
                        </ul>
                    </aside>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="county" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagOptional">Optional</span> county</h3>
                    <div class="tsd-signature tsd-kind-icon">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></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L46">src/types.ts:46</a></li>
                        </ul>
                    </aside>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="latitude" class="tsd-anchor"></a>
                    <h3>latitude</h3>
                    <div class="tsd-signature tsd-kind-icon">latitude<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L47">src/types.ts:47</a></li>
                        </ul>
                    </aside>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="location" class="tsd-anchor"></a>
                    <h3>location</h3>
                    <div class="tsd-signature tsd-kind-icon">location<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L43">src/types.ts:43</a></li>
                        </ul>
                    </aside>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="longitude" class="tsd-anchor"></a>
                    <h3>longitude</h3>
                    <div class="tsd-signature tsd-kind-icon">longitude<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L48">src/types.ts:48</a></li>
                        </ul>
                    </aside>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="provinceorstate" class="tsd-anchor"></a>
                    <h3><span class="tsd-flag ts-flagOptional">Optional</span> province<wbr>OrState</h3>
                    <div class="tsd-signature tsd-kind-icon">province<wbr>OrState<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></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L45">src/types.ts:45</a></li>
                        </ul>
                    </aside>
                </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="../modules/_covid19api_.html">&quot;COVID19API&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_covid19apierror_.html">&quot;COVID19APIError&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_datagetter_datagetter_.html">&quot;<wbr>Data<wbr>Getter/<wbr>Data<wbr>Getter&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_datagetter_filegetter_.html">&quot;<wbr>Data<wbr>Getter/<wbr>File<wbr>Getter&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_datagetter_githubgetter_.html">&quot;<wbr>Data<wbr>Getter/<wbr>Git<wbr>Hub<wbr>Getter&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_datastore_datastore_.html">&quot;<wbr>Data<wbr>Store/<wbr>Data<wbr>Store&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_datastore_indexeddbstore_.html">&quot;<wbr>Data<wbr>Store/<wbr>IndexedDBStore&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_datastore_memorystore_.html">&quot;<wbr>Data<wbr>Store/<wbr>Memory<wbr>Store&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_format_.html">&quot;format&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_index_.html">&quot;index&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_parse_.html">&quot;parse&quot;</a>
                    </li>
                    <li class="current tsd-kind-module">
                        <a href="../modules/_types_.html">&quot;types&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_uslocations_.html">&quot;us<wbr>Locations&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_usstates_.html">&quot;us<wbr>States&quot;</a>
                    </li>
                    <li class=" tsd-kind-module">
                        <a href="../modules/_utils_.html">&quot;utils&quot;</a>
                    </li>
                </ul>
            </nav>
            <nav class="tsd-navigation secondary menu-sticky">
                <ul class="before-current">
                    <li class=" tsd-kind-interface tsd-parent-kind-module">
                        <a href="_types_.internallocationdata.html" class="tsd-kind-icon">Internal<wbr>Location<wbr>Data</a>
                    </li>
                    <li class=" tsd-kind-interface tsd-parent-kind-module">
                        <a href="_types_.internalvaluesondate.html" class="tsd-kind-icon">Internal<wbr>Values<wbr>OnDate</a>
                    </li>
                    <li class=" tsd-kind-interface tsd-parent-kind-module">
                        <a href="_types_.locationdata.html" class="tsd-kind-icon">Location<wbr>Data</a>
                    </li>
                </ul>
                <ul class="current">
                    <li class="current tsd-kind-interface tsd-parent-kind-module">
                        <a href="_types_.locationinfo.html" class="tsd-kind-icon">Location<wbr>Info</a>
                        <ul>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.locationinfo.html#countryorregion" class="tsd-kind-icon">country<wbr>OrRegion</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.locationinfo.html#county" class="tsd-kind-icon">county</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.locationinfo.html#latitude" class="tsd-kind-icon">latitude</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.locationinfo.html#location" class="tsd-kind-icon">location</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.locationinfo.html#longitude" class="tsd-kind-icon">longitude</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.locationinfo.html#provinceorstate" class="tsd-kind-icon">province<wbr>OrState</a>
                            </li>
                        </ul>
                    </li>
                </ul>
                <ul class="after-current">
                    <li class=" tsd-kind-interface tsd-parent-kind-module">
                        <a href="_types_.valuesondate.html" class="tsd-kind-icon">Values<wbr>OnDate</a>
                    </li>
                    <li class=" tsd-kind-type-alias tsd-parent-kind-module">
                        <a href="../modules/_types_.html#fetch" class="tsd-kind-icon">Fetch</a>
                    </li>
                    <li class=" tsd-kind-type-alias tsd-parent-kind-module">
                        <a href="../modules/_types_.html#internallocationdatavalues" class="tsd-kind-icon">Internal<wbr>Location<wbr>Data<wbr>Values</a>
                    </li>
                    <li class=" tsd-kind-type-alias tsd-parent-kind-module">
                        <a href="../modules/_types_.html#locationdatavalues" class="tsd-kind-icon">Location<wbr>Data<wbr>Values</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>
                <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>