covidtracker/README.md

An Api wrapper to get information about the Novel Coronavirus.

# Covid-19 Tracker

View information on the Coronavirus outbreak around the world.
*Updated By: [Apollo#6000](https://infernobot.xyz/)*

# Update:
- Updated the API Wrapper to V2 of https://corona.lmao.ninja/v2/

![npm](https://flat.badgen.net/npm/v/covidtracker) ![InstallSize](https://badgen.net/packagephobia/install/covidtracker) [![Discord](https://img.shields.io/badge/Discord-600%20Online-7289da)](https://discord.gg/tTEBTxR)


[Beta NPM Package](https://www.npmjs.com/package/covidtracker)
  

## Installation

Stable Release (`v2.0.1`)

```js
npm i covidtracker@2.0.1
```

### Methods

**.getAll()**

**.getCountry({country, sort})**

**.getState({state, sort})**

**.getHistoric({country, province})**

**.getJHU({country, province, sort})**

## Loading and using the module

We suggest you load the module via `require`, pending the stabalizing of es modules in node:

```js
const covid = require('covidtracker');
```

# Documentation

To actually use the data, you will need an [async/await](https://javascript.info/async-await).

```js
// Declare the package
const covid = require('covidtracker');

// Now we create a async/await
(async () => {

    // Now we await it.
    let all = await covid.getAll();

    // Make sure you return it, this usually implies if you are using this inside a function.
    // Use \n to break lines.
    return console.log(`Cases: ${all.cases}\nDeaths: ${all.deaths}\nRecovered: ${all.recovered}`)
})()
```

#### Sorting the data.

Some [methods](https://www.npmjs.com/package/covidtracker#methods) can be sorted.

```js
const covid = require('covidtracker');

(async () => {
    let sortedCountries = await covid.getCountry({sort: 'recovered'});
    return console.log(sortedCountries);

    let sortedStates = await covid.getState({sort: 'deaths'});
    return console.log(sortedStates);
})();
```

#### Filtering for a specific country/state.
```js
const covid = require('covidtracker');

(async () => {
   // Specific Country
   let specificCountry = await covid.getCountry({country: 'United States'});
   return console.log(specificCountry);
   
   // Specific State
   let specificState = await covid.getState({state: 'New York'});
   return console.log(specificCountry);
})();
```