Why use poke-api?

poke-api is async. As such, all functions return a 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

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.

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.