docs/modules/_covid19api_.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>"COVID19API" | 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="_covid19api_.html">"COVID19API"</a>
</li>
</ul>
<h1>Module "COVID19API"</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>Classes</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_covid19api_.covid19api.html" class="tsd-kind-icon">COVID19API</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_covid19api_.covid19apialreadyinitializederror.html" class="tsd-kind-icon">COVID19APIAlready<wbr>Initialized<wbr>Error</a></li>
<li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/_covid19api_.covid19apinotinitializederror.html" class="tsd-kind-icon">COVID19APINot<wbr>Initialized<wbr>Error</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Interfaces</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-interface tsd-parent-kind-module"><a href="../interfaces/_covid19api_.covid19apioptions.html" class="tsd-kind-icon">COVID19APIOptions</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-not-exported">
<h3>Type aliases</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_covid19api_.html#filepaths" class="tsd-kind-icon">File<wbr>Paths</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_covid19api_.html#loadfromoptions" class="tsd-kind-icon">Load<wbr>From<wbr>Options</a></li>
<li class="tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported"><a href="_covid19api_.html#storeoptions" class="tsd-kind-icon">Store<wbr>Options</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
<h2>Type aliases</h2>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a name="filepaths" class="tsd-anchor"></a>
<h3>File<wbr>Paths</h3>
<div class="tsd-signature tsd-kind-icon">File<wbr>Paths<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>globalConfirmedCSVPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>globalDeathsCSVPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>globalRecoveredCSVPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usConfirmedCSVPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span>usDeathsCSVPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> }</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/COVID19API.ts#L15">src/COVID19API.ts:15</a></li>
</ul>
</aside>
<div class="tsd-type-declaration">
<h4>Type declaration</h4>
<ul class="tsd-parameters">
<li class="tsd-parameter">
<h5>global<wbr>ConfirmedCSVPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>global<wbr>DeathsCSVPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>global<wbr>RecoveredCSVPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>us<wbr>ConfirmedCSVPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
<li class="tsd-parameter">
<h5>us<wbr>DeathsCSVPath<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5>
</li>
</ul>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a name="loadfromoptions" class="tsd-anchor"></a>
<h3>Load<wbr>From<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">Load<wbr>From<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"github"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"files"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/COVID19API.ts#L13">src/COVID19API.ts:13</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a name="storeoptions" class="tsd-anchor"></a>
<h3>Store<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">Store<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">"memory"</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">"indexeddb"</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/evrimfeyyaz/covid-19-api/blob/4e0339e/src/COVID19API.ts#L14">src/COVID19API.ts:14</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="current tsd-kind-module">
<a href="_covid19api_.html">"COVID19API"</a>
</li>
<li class=" tsd-kind-module">
<a href="_covid19apierror_.html">"COVID19APIError"</a>
</li>
<li class=" tsd-kind-module">
<a href="_datagetter_datagetter_.html">"<wbr>Data<wbr>Getter/<wbr>Data<wbr>Getter"</a>
</li>
<li class=" tsd-kind-module">
<a href="_datagetter_filegetter_.html">"<wbr>Data<wbr>Getter/<wbr>File<wbr>Getter"</a>
</li>
<li class=" tsd-kind-module">
<a href="_datagetter_githubgetter_.html">"<wbr>Data<wbr>Getter/<wbr>Git<wbr>Hub<wbr>Getter"</a>
</li>
<li class=" tsd-kind-module">
<a href="_datastore_datastore_.html">"<wbr>Data<wbr>Store/<wbr>Data<wbr>Store"</a>
</li>
<li class=" tsd-kind-module">
<a href="_datastore_indexeddbstore_.html">"<wbr>Data<wbr>Store/<wbr>IndexedDBStore"</a>
</li>
<li class=" tsd-kind-module">
<a href="_datastore_memorystore_.html">"<wbr>Data<wbr>Store/<wbr>Memory<wbr>Store"</a>
</li>
<li class=" tsd-kind-module">
<a href="_format_.html">"format"</a>
</li>
<li class=" tsd-kind-module">
<a href="_index_.html">"index"</a>
</li>
<li class=" tsd-kind-module">
<a href="_parse_.html">"parse"</a>
</li>
<li class=" tsd-kind-module">
<a href="_types_.html">"types"</a>
</li>
<li class=" tsd-kind-module">
<a href="_uslocations_.html">"us<wbr>Locations"</a>
</li>
<li class=" tsd-kind-module">
<a href="_usstates_.html">"us<wbr>States"</a>
</li>
<li class=" tsd-kind-module">
<a href="_utils_.html">"utils"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/_covid19api_.covid19api.html" class="tsd-kind-icon">COVID19API</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/_covid19api_.covid19apialreadyinitializederror.html" class="tsd-kind-icon">COVID19APIAlready<wbr>Initialized<wbr>Error</a>
</li>
<li class=" tsd-kind-class tsd-parent-kind-module">
<a href="../classes/_covid19api_.covid19apinotinitializederror.html" class="tsd-kind-icon">COVID19APINot<wbr>Initialized<wbr>Error</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-module">
<a href="../interfaces/_covid19api_.covid19apioptions.html" class="tsd-kind-icon">COVID19APIOptions</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="_covid19api_.html#filepaths" class="tsd-kind-icon">File<wbr>Paths</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="_covid19api_.html#loadfromoptions" class="tsd-kind-icon">Load<wbr>From<wbr>Options</a>
</li>
<li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-is-not-exported">
<a href="_covid19api_.html#storeoptions" class="tsd-kind-icon">Store<wbr>Options</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>