docs/modules/_format_.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>"format" | 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="_format_.html">"format"</a>
</li>
</ul>
<h1>Module "format"</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="_format_.html#formatglobalparseddata" class="tsd-kind-icon">format<wbr>Global<wbr>Parsed<wbr>Data</a></li>
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_format_.html#formatparseddata" class="tsd-kind-icon">format<wbr>Parsed<wbr>Data</a></li>
<li class="tsd-kind-function tsd-parent-kind-module"><a href="_format_.html#formatusparseddata" class="tsd-kind-icon">formatUSParsed<wbr>Data</a></li>
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_format_.html#getaustraliatotaldata" class="tsd-kind-icon">get<wbr>Australia<wbr>Total<wbr>Data</a></li>
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_format_.html#getcanadatotaldata" class="tsd-kind-icon">get<wbr>Canada<wbr>Total<wbr>Data</a></li>
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_format_.html#getchinatotaldata" class="tsd-kind-icon">get<wbr>China<wbr>Total<wbr>Data</a></li>
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_format_.html#getusstatetotalsdata" class="tsd-kind-icon">getUSState<wbr>Totals<wbr>Data</a></li>
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_format_.html#getvaluesfromparsedrows" class="tsd-kind-icon">get<wbr>Values<wbr>From<wbr>Parsed<wbr>Rows</a></li>
<li class="tsd-kind-function tsd-parent-kind-module tsd-is-not-exported"><a href="_format_.html#summultiplelocationvalues" class="tsd-kind-icon">sum<wbr>Multiple<wbr>Location<wbr>Values</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="formatglobalparseddata" class="tsd-anchor"></a>
<h3>format<wbr>Global<wbr>Parsed<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">format<wbr>Global<wbr>Parsed<wbr>Data<span class="tsd-signature-symbol">(</span>parsedGlobalConfirmedData<span class="tsd-signature-symbol">: </span><a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a>, parsedGlobalDeathsData<span class="tsd-signature-symbol">: </span><a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a>, parsedGlobalRecoveredData<span class="tsd-signature-symbol">: </span><a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</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><span class="tsd-signature-symbol">[]</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/format.ts#L273">src/format.ts:273</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts parsed CSV objects that contain global COVID-19 time series into an easier to consume
format.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>parsedGlobalConfirmedData: <a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a></h5>
</li>
<li>
<h5>parsedGlobalDeathsData: <a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a></h5>
</li>
<li>
<h5>parsedGlobalRecoveredData: <a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a name="formatparseddata" class="tsd-anchor"></a>
<h3>format<wbr>Parsed<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">format<wbr>Parsed<wbr>Data<span class="tsd-signature-symbol">(</span>parsedConfirmedData<span class="tsd-signature-symbol">: </span><a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a>, parsedDeathsData<span class="tsd-signature-symbol">: </span><a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a>, parsedRecoveredData<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</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><span class="tsd-signature-symbol">[]</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/format.ts#L213">src/format.ts:213</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts parsed CSV objects into an easier to consume format.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>parsedConfirmedData: <a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a></h5>
</li>
<li>
<h5>parsedDeathsData: <a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> parsedRecoveredData: <a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module">
<a name="formatusparseddata" class="tsd-anchor"></a>
<h3>formatUSParsed<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module">
<li class="tsd-signature tsd-kind-icon">formatUSParsed<wbr>Data<span class="tsd-signature-symbol">(</span>parsedUSConfirmedData<span class="tsd-signature-symbol">: </span><a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a>, parsedUsDeathsData<span class="tsd-signature-symbol">: </span><a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</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><span class="tsd-signature-symbol">[]</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/format.ts#L318">src/format.ts:318</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Converts parsed CSV objects that contain US COVID-19 time series into an easier to consume
format.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>parsedUSConfirmedData: <a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a></h5>
</li>
<li>
<h5>parsedUsDeathsData: <a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a><span class="tsd-signature-symbol">[]</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a name="getaustraliatotaldata" class="tsd-anchor"></a>
<h3>get<wbr>Australia<wbr>Total<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">get<wbr>Australia<wbr>Total<wbr>Data<span class="tsd-signature-symbol">(</span>australiaStateData<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><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/format.ts#L56">src/format.ts:56</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculates the data for Australia.</p>
</div>
<p><em>The values for Australia are represented separately for each state in the JHU CSSE data. This
function calculates the country totals by summing the data for all the states in Australia.</em></p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>australiaStateData: <a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p><a href="../interfaces/_types_.internallocationdata.html">InternalLocationData</a> array containing the data for all the
states of Australia.</p>
</div>
</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 tsd-is-not-exported">
<a name="getcanadatotaldata" class="tsd-anchor"></a>
<h3>get<wbr>Canada<wbr>Total<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">get<wbr>Canada<wbr>Total<wbr>Data<span class="tsd-signature-symbol">(</span>globalParsedRecoveredDataCSV<span class="tsd-signature-symbol">: </span><a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a>, canadaProvinceData<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><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/format.ts#L84">src/format.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculates the data for Canada.</p>
</div>
<p><em>The values for Canada are represented separately for each state in the JHU CSSE data. This
function calculates the country totals by summing the data for all the provinces in Canada.</em></p>
<p>*Also, there is no recoveries data for any of the provinces of Canada in the JHU CSSE data, but
there is recoveries data for Canada as a whole. This function incorporates this recoveries data
into the returned <a href="../interfaces/_types_.internallocationdata.html">InternalLocationData</a> object.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>globalParsedRecoveredDataCSV: <a href="../interfaces/_parse_.parsedcsv.html" class="tsd-signature-type">ParsedCSV</a></h5>
<div class="tsd-comment tsd-typography">
<p>The <a href="../interfaces/_parse_.parsedcsv.html">ParsedCSV</a> object containing the global
recoveries time series data.</p>
</div>
</li>
<li>
<h5>canadaProvinceData: <a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p><a href="../interfaces/_types_.internallocationdata.html">InternalLocationData</a> array containing the data for all the
provinces of Canada.</p>
</div>
</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 tsd-is-not-exported">
<a name="getchinatotaldata" class="tsd-anchor"></a>
<h3>get<wbr>China<wbr>Total<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">get<wbr>China<wbr>Total<wbr>Data<span class="tsd-signature-symbol">(</span>chinaProvinceData<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><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/format.ts#L117">src/format.ts:117</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculates the data for China.</p>
</div>
<p><em>The values for China are represented separately for each province in the JHU CSSE data. This
function calculates the country totals by summing the data for all the provinces in China.</em></p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>chinaProvinceData: <a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p><a href="../interfaces/_types_.internallocationdata.html">InternalLocationData</a> array containing the data for all the
provinces of China.</p>
</div>
</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 tsd-is-not-exported">
<a name="getusstatetotalsdata" class="tsd-anchor"></a>
<h3>getUSState<wbr>Totals<wbr>Data</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">getUSState<wbr>Totals<wbr>Data<span class="tsd-signature-symbol">(</span>usCountyData<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><span class="tsd-signature-symbol">: </span><a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a><span class="tsd-signature-symbol">[]</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/format.ts#L141">src/format.ts:141</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Calculates the data for all US states.</p>
</div>
<p><em>The values in the US data files only include data at the county level. This function calculates
state totals by summing the data for all counties of a given state.</em></p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>usCountyData: <a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p><a href="../interfaces/_types_.internallocationdata.html">InternalLocationData</a> array containing the data for all of the
counties in the USA.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../interfaces/_types_.internallocationdata.html" class="tsd-signature-type">InternalLocationData</a><span class="tsd-signature-symbol">[]</span></h4>
<p>An array of <a href="../interfaces/_types_.internallocationdata.html">InternalLocationData</a> with each element containing the data for a US
state.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a name="getvaluesfromparsedrows" class="tsd-anchor"></a>
<h3>get<wbr>Values<wbr>From<wbr>Parsed<wbr>Rows</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">get<wbr>Values<wbr>From<wbr>Parsed<wbr>Rows<span class="tsd-signature-symbol">(</span>dateKeys<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span>, confirmedData<span class="tsd-signature-symbol">: </span><a href="../interfaces/_parse_.parsedcsvrow.html" class="tsd-signature-type">ParsedCSVRow</a>, deathsData<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_parse_.parsedcsvrow.html" class="tsd-signature-type">ParsedCSVRow</a>, recoveredData<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_parse_.parsedcsvrow.html" class="tsd-signature-type">ParsedCSVRow</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_types_.html#internallocationdatavalues" class="tsd-signature-type">InternalLocationDataValues</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/format.ts#L178">src/format.ts:178</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Extracts values (confirmed cases, deaths and recoveries) from the given CSV rows.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>dateKeys: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
<p>All keys of the given <a href="../interfaces/_parse_.parsedcsvrow.html">ParsedCSVRow</a> objects that contain a value for a
certain day.</p>
</div>
</li>
<li>
<h5>confirmedData: <a href="../interfaces/_parse_.parsedcsvrow.html" class="tsd-signature-type">ParsedCSVRow</a></h5>
<div class="tsd-comment tsd-typography">
<p>A <a href="../interfaces/_parse_.parsedcsvrow.html">ParsedCSVRow</a> object containing the confirmed cases data for a
location.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> deathsData: <a href="../interfaces/_parse_.parsedcsvrow.html" class="tsd-signature-type">ParsedCSVRow</a></h5>
<div class="tsd-comment tsd-typography">
<p>A <a href="../interfaces/_parse_.parsedcsvrow.html">ParsedCSVRow</a> object containing the deaths data for a certain
location.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> recoveredData: <a href="../interfaces/_parse_.parsedcsvrow.html" class="tsd-signature-type">ParsedCSVRow</a></h5>
<div class="tsd-comment tsd-typography">
<p>A <a href="../interfaces/_parse_.parsedcsvrow.html">ParsedCSVRow</a> object containing the recoveries data for a
location.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_types_.html#internallocationdatavalues" class="tsd-signature-type">InternalLocationDataValues</a></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a name="summultiplelocationvalues" class="tsd-anchor"></a>
<h3>sum<wbr>Multiple<wbr>Location<wbr>Values</h3>
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon">sum<wbr>Multiple<wbr>Location<wbr>Values<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><span class="tsd-signature-symbol">: </span><a href="_types_.html#internallocationdatavalues" class="tsd-signature-type">InternalLocationDataValues</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/format.ts#L11">src/format.ts:11</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Sums confirmed cases, deaths and recoveries in the given <a href="../interfaces/_types_.internallocationdata.html">InternalLocationData</a> objects.</p>
</div>
</div>
<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><span class="tsd-signature-symbol">[]</span></h5>
<div class="tsd-comment tsd-typography">
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_types_.html#internallocationdatavalues" class="tsd-signature-type">InternalLocationDataValues</a></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">"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="current 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-function tsd-parent-kind-module">
<a href="_format_.html#formatglobalparseddata" class="tsd-kind-icon">format<wbr>Global<wbr>Parsed<wbr>Data</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="_format_.html#formatparseddata" class="tsd-kind-icon">format<wbr>Parsed<wbr>Data</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="_format_.html#formatusparseddata" class="tsd-kind-icon">formatUSParsed<wbr>Data</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="_format_.html#getaustraliatotaldata" class="tsd-kind-icon">get<wbr>Australia<wbr>Total<wbr>Data</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="_format_.html#getcanadatotaldata" class="tsd-kind-icon">get<wbr>Canada<wbr>Total<wbr>Data</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="_format_.html#getchinatotaldata" class="tsd-kind-icon">get<wbr>China<wbr>Total<wbr>Data</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="_format_.html#getusstatetotalsdata" class="tsd-kind-icon">getUSState<wbr>Totals<wbr>Data</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="_format_.html#getvaluesfromparsedrows" class="tsd-kind-icon">get<wbr>Values<wbr>From<wbr>Parsed<wbr>Rows</a>
</li>
<li class=" tsd-kind-function tsd-parent-kind-module tsd-is-not-exported">
<a href="_format_.html#summultiplelocationvalues" class="tsd-kind-icon">sum<wbr>Multiple<wbr>Location<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>
</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>