easier-pokemon/README.md

An easier way to get pokemon stats.

[![npm](https://img.shields.io/npm/v/easier-pokemon.svg)](https://www.npmjs.com/package/easier-pokemon)
[![npm](https://img.shields.io/npm/dt/easier-pokemon.svg?maxAge=3600)](https://www.npmjs.com/package/easier-pokemon)
[![install size](https://packagephobia.now.sh/badge?p=easier-pokemon)](https://www.npmjs.com/package/easier-pokemon)

![NPM](https://nodei.co/npm/easier-pokemon.png?downloads=true&downloadRank=true&stars=true)

# Easier-Pokemon

## Installation
```
npm i easier-pokemon
```
An easier way to get data from pokeapi.co

### Data

| Pokemon | Description |
| -------- | ----------- |
| `pokemon: 'pokemon-name'` | Sets the default pokemon for all other functions (This is needed) |
| `pokedata: true` | Returns all the data for the pokemon you chose |
----------------------------------------------------------------------
| Weight | Description |
| -------- | ----------- |
| `weight: 'all'` | Returns the weight of the pokemon |
----------------------------------------------------------------------
| Abilities | Description |
| -------- | ----------- |
| `abilities: 'all'` | Returns the all the abilities data for the pokemon |
| `abilities: 'names'` | Returns the names of all the abilities of the pokemon in an array |
| `abilities: 'urls'` | Returns the urls of all the abilities of the pokemon in an array ex. https://pokeapi.co/api/v2/ability/9/ |
----------------------------------------------------------------------
| Male Sprites | Description |
| -------- | ----------- |
| `sprites: 'back'` | Returns the image URL of the pokemons back (default is male) |
| `sprites: 'back_shiny'` | Returns the image URL of the pokemons back but as a shiny (default is male) |
| `sprites: 'front'` | Returns the image URL of the pokemons front (default is male) |
| `sprites: 'front_shiny'` | Returns the image URL of the pokemons front but as a shiny (default is male) |
----------------------------------------------------------------------
| Female Sprites | Description |
| -------- | ----------- |
| `fsprites: 'back'` | Returns the image URL of the pokemons back (default is female) |
| `fsprites: 'back_shiny'` | Returns the image URL of the pokemons back but as a shiny (default is female) |
| `fsprites: 'front'` | Returns the image URL of the pokemons front (default is female) |
| `fsprites: 'front_shiny'` | Returns the image URL of the pokemons front but as a shiny (default is female) |
----------------------------------------------------------------------
| Experience | Description |
| -------- | ----------- |
| `experience: 'base'` | Returns the base experience of the pokemon |
----------------------------------------------------------------------
| Types | Description |
| -------- | ----------- |
| `types: 'all'` | Returns all the type data for the pokemon |
| `types: 'name'` | Returns the name of the type for the pokemon |
| `types: 'url'` | Returns the url of the type for the pokemon |
----------------------------------------------------------------------
## Examples

Async/Await Example
```js
const pokeapi = require('easier-pokemon')

async function test() {
  await pokeapi.PokeApi({
    pokemon: 'pikachu',
    pokedata: true
  }, res => console.log(res))
}
test()
```
returns: 
```js
{
  abilities: [
    { ability: [Object], is_hidden: false, slot: 1 },
    { ability: [Object], is_hidden: true, slot: 3 }
  ],
  base_experience: 112,
  forms: [
    {
      name: 'pikachu',
      url: 'https://pokeapi.co/api/v2/pokemon-form/25/'
    }
  ],
  game_indices: [
    { game_index: 84, version: [Object] },
    { game_index: 84, version: [Object] },
    { game_index: 84, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] },
    { game_index: 25, version: [Object] }
  ],
  height: 4,
  held_items: [
    { item: [Object], version_details: [Array] },
    { item: [Object], version_details: [Array] }
  ],
  id: 25,
  is_default: true,
  location_area_encounters: 'https://pokeapi.co/api/v2/pokemon/25/encounters',

  ...
```

This might be updated with more advanced functions.