evrimfeyyaz/covid-19-api

View on GitHub
docs/interfaces/_types_.valuesondate.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>ValuesOnDate | 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_.valuesondate.html">ValuesOnDate</a>
                </li>
            </ul>
            <h1>Interface ValuesOnDate</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 all the data on a certain date.</p>
                    </div>
                </div>
            </section>
            <section class="tsd-panel tsd-hierarchy">
                <h3>Hierarchy</h3>
                <ul class="tsd-hierarchy">
                    <li>
                        <a href="_types_.internalvaluesondate.html" class="tsd-signature-type">InternalValuesOnDate</a>
                        <ul class="tsd-hierarchy">
                            <li>
                                <span class="target">ValuesOnDate</span>
                            </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_.valuesondate.html#activecases" class="tsd-kind-icon">active<wbr>Cases</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_.valuesondate.html#casefatalityrate" class="tsd-kind-icon">case<wbr>Fatality<wbr>Rate</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_types_.valuesondate.html#confirmed" class="tsd-kind-icon">confirmed</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_types_.valuesondate.html#date" class="tsd-kind-icon">date</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_types_.valuesondate.html#deaths" class="tsd-kind-icon">deaths</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_.valuesondate.html#newconfirmed" class="tsd-kind-icon">new<wbr>Confirmed</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_.valuesondate.html#newdeaths" class="tsd-kind-icon">new<wbr>Deaths</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_.valuesondate.html#newrecovered" class="tsd-kind-icon">new<wbr>Recovered</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface tsd-is-inherited"><a href="_types_.valuesondate.html#recovered" class="tsd-kind-icon">recovered</a></li>
                                <li class="tsd-kind-property tsd-parent-kind-interface"><a href="_types_.valuesondate.html#recoveryrate" class="tsd-kind-icon">recovery<wbr>Rate</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="activecases" class="tsd-anchor"></a>
                    <h3>active<wbr>Cases</h3>
                    <div class="tsd-signature tsd-kind-icon">active<wbr>Cases<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L79">src/types.ts:79</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The number of active cases on this date. <code>null</code> if either the <code>deaths</code> or <code>recovered</code> data is
                            not available, as without them the number of active cases cannot be calculated.</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="casefatalityrate" class="tsd-anchor"></a>
                    <h3>case<wbr>Fatality<wbr>Rate</h3>
                    <div class="tsd-signature tsd-kind-icon">case<wbr>Fatality<wbr>Rate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L66">src/types.ts:66</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The case fatality rate on this date. <code>null</code> if this information is not available.</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
                    <a name="confirmed" class="tsd-anchor"></a>
                    <h3>confirmed</h3>
                    <div class="tsd-signature tsd-kind-icon">confirmed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
                    <aside class="tsd-sources">
                        <p>Inherited from <a href="_types_.internalvaluesondate.html">InternalValuesOnDate</a>.<a href="_types_.internalvaluesondate.html#confirmed">confirmed</a></p>
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L12">src/types.ts:12</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The number of confirmed cases.</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
                    <a name="date" class="tsd-anchor"></a>
                    <h3>date</h3>
                    <div class="tsd-signature tsd-kind-icon">date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
                    <aside class="tsd-sources">
                        <p>Inherited from <a href="_types_.internalvaluesondate.html">InternalValuesOnDate</a>.<a href="_types_.internalvaluesondate.html#date">date</a></p>
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L8">src/types.ts:8</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The date of the values.</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
                    <a name="deaths" class="tsd-anchor"></a>
                    <h3>deaths</h3>
                    <div class="tsd-signature tsd-kind-icon">deaths<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
                    <aside class="tsd-sources">
                        <p>Inherited from <a href="_types_.internalvaluesondate.html">InternalValuesOnDate</a>.<a href="_types_.internalvaluesondate.html#deaths">deaths</a></p>
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L16">src/types.ts:16</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The number of deaths. <code>null</code> if this information is not available.</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="newconfirmed" class="tsd-anchor"></a>
                    <h3>new<wbr>Confirmed</h3>
                    <div class="tsd-signature tsd-kind-icon">new<wbr>Confirmed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L58">src/types.ts:58</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The number of new confirmed cases on this date.</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="newdeaths" class="tsd-anchor"></a>
                    <h3>new<wbr>Deaths</h3>
                    <div class="tsd-signature tsd-kind-icon">new<wbr>Deaths<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L62">src/types.ts:62</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The number of new deaths on this date. <code>null</code> if this information is not available.</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="newrecovered" class="tsd-anchor"></a>
                    <h3>new<wbr>Recovered</h3>
                    <div class="tsd-signature tsd-kind-icon">new<wbr>Recovered<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L70">src/types.ts:70</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The number of new recoveries on this date. <code>null</code> if this information is not available.</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
                    <a name="recovered" class="tsd-anchor"></a>
                    <h3>recovered</h3>
                    <div class="tsd-signature tsd-kind-icon">recovered<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
                    <aside class="tsd-sources">
                        <p>Inherited from <a href="_types_.internalvaluesondate.html">InternalValuesOnDate</a>.<a href="_types_.internalvaluesondate.html#recovered">recovered</a></p>
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L20">src/types.ts:20</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The number of recoveries. <code>null</code> if this information is not available.</p>
                        </div>
                    </div>
                </section>
                <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
                    <a name="recoveryrate" class="tsd-anchor"></a>
                    <h3>recovery<wbr>Rate</h3>
                    <div class="tsd-signature tsd-kind-icon">recovery<wbr>Rate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
                    <aside class="tsd-sources">
                        <ul>
                            <li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/types.ts#L74">src/types.ts:74</a></li>
                        </ul>
                    </aside>
                    <div class="tsd-comment tsd-typography">
                        <div class="lead">
                            <p>The recovery rate out of all confirmed cases.</p>
                        </div>
                    </div>
                </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>
                    <li class=" tsd-kind-interface tsd-parent-kind-module">
                        <a href="_types_.locationinfo.html" class="tsd-kind-icon">Location<wbr>Info</a>
                    </li>
                </ul>
                <ul class="current">
                    <li class="current tsd-kind-interface tsd-parent-kind-module">
                        <a href="_types_.valuesondate.html" class="tsd-kind-icon">Values<wbr>OnDate</a>
                        <ul>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.valuesondate.html#activecases" class="tsd-kind-icon">active<wbr>Cases</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.valuesondate.html#casefatalityrate" class="tsd-kind-icon">case<wbr>Fatality<wbr>Rate</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
                                <a href="_types_.valuesondate.html#confirmed" class="tsd-kind-icon">confirmed</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
                                <a href="_types_.valuesondate.html#date" class="tsd-kind-icon">date</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
                                <a href="_types_.valuesondate.html#deaths" class="tsd-kind-icon">deaths</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.valuesondate.html#newconfirmed" class="tsd-kind-icon">new<wbr>Confirmed</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.valuesondate.html#newdeaths" class="tsd-kind-icon">new<wbr>Deaths</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.valuesondate.html#newrecovered" class="tsd-kind-icon">new<wbr>Recovered</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-inherited">
                                <a href="_types_.valuesondate.html#recovered" class="tsd-kind-icon">recovered</a>
                            </li>
                            <li class=" tsd-kind-property tsd-parent-kind-interface">
                                <a href="_types_.valuesondate.html#recoveryrate" class="tsd-kind-icon">recovery<wbr>Rate</a>
                            </li>
                        </ul>
                    </li>
                </ul>
                <ul class="after-current">
                    <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>