| 1 | # COVID19 API Wrapper (Node.js)
|
| 2 |
|
| 3 | [](https://badge.fury.io/js/jhu-covid19-api) [](https://packagephobia.now.sh/result?p=jhu-covid19-api)
|
| 4 |
|
| 5 | API wrapper for [COVID19 API](https://covid19api.com/).
|
| 6 |
|
| 7 | *Data is sourced from Johns Hopkins University.*
|
| 8 |
|
| 9 | ## Quick start
|
| 10 |
|
| 11 | ```bash
|
| 12 | npm i -s jhu-covid19-api
|
| 13 | ```
|
| 14 |
|
| 15 | ```js
|
| 16 | // Initialize COVID19 API.
|
| 17 | const covid = require('jhu-covid19-api');
|
| 18 |
|
| 19 | (async () => {
|
| 20 |
|
| 21 | // Retrieve summary.
|
| 22 | const summary = await covid.summary();
|
| 23 |
|
| 24 | console.log('Summary:', summary);
|
| 25 |
|
| 26 | })();
|
| 27 | ```
|
| 28 |
|
| 29 | ### Documentation
|
| 30 |
|
| 31 | Generate docs:
|
| 32 |
|
| 33 | ```bash
|
| 34 | npm run docs
|
| 35 | ```
|
| 36 |
|
| 37 | Start HTTP server serving docs:
|
| 38 |
|
| 39 | ```bash
|
| 40 | npm run http-docs
|
| 41 | ```
|
| 42 |
|
| 43 | ---
|
| 44 |
|
| 45 | #### To do list:
|
| 46 |
|
| 47 | - [x] API documentation
|
| 48 | - [ ] Routes extension
|