Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
poke-api.js
Advanced tools
poke-api.js - npm Package Compare versions
Comparing version 1.0.0 to 1.0.1
| { | ||
| "name": "poke-api.js", | ||
| "version": "1.0.0", | ||
| "version": "1.0.1", | ||
| "description": "A promised based wrapper for the Poke API", | ||
@@ -5,0 +5,0 @@ "main": "index.js", |
@@ -1,40 +0,2 @@ | ||
| # Why use poke-api? | ||
| poke-api is async. As such, all functions return a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) | ||
| Poke-API uses one dependency, which is very light. Everything is documented and easy to use. | ||
| # Installation | ||
| Requires node **8.0.0** or higher | ||
| `npm install poke-api` | ||
| # Examples | ||
| ```javascript | ||
| const API = require('poke-api'); | ||
| // get metadata of a Pokemon | ||
| API.getPokemon('bulbasaur').then(pokemon => { | ||
| console.log(`Bulbasaur has height ${pokemon.height}!`); | ||
| }); | ||
| // or use await with an async function | ||
| (async function() { | ||
| const pokemon = await API.getPokemon('bulbasaur'); | ||
| console.log(`Bulbasaur has height ${pokemon.height}!`); | ||
| })() | ||
| ``` | ||
| **Note**: All functions return a Promise. | ||
| # Credits | ||
| Major credit to the designers of the Pokemon API | ||
| # Contributing | ||
| Everyone can contribute by opening a pull request. | ||
| <<<<<<< HEAD | ||
| <<<<<<< HEAD | ||
| # Why use poke-api? | ||
@@ -77,8 +39,2 @@ | ||
| Everyone can contribute by opening a pull request. | ||
| In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code. | ||
| ======= | ||
| In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code. | ||
| >>>>>>> 387d1a4d1e7f0d783130d3e21ab31a7cedec2ee4 | ||
| ======= | ||
| In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code. | ||
| >>>>>>> 387d1a4d1e7f0d783130d3e21ab31a7cedec2ee4 | ||
| In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code. |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-16.64%
6808
- Number of lines in readme file
- decreased by-53.57%
39
No dependency changes