pkmonjs
TypeScript icon, indicating that this package has built-in type declarations

1.6.4 • Public • Published

PkmonJs

Build Status npm npm

A package to use the PokeApi

Author

Installation

Install pkmonjs with NPM

  npm install pkmonjs

or Yarn

  yarn add pkmonjs

Demonstration

Enter a pokemon name will receive an object as a response

JavaScript

    const {getPokemon,getAllPokemon,getAllPokemonNames} = require('pkmonjs')

    const poke = getPokemon('pikachu').then((f)=>
     {
        if(f) {
          console.log(f)
        }
     }
    )
    //or use await
    const poke =await getPokemon('pikachu')

    const names=await getAllPokemonNames()

    const pokes=await getAllPokemonNames()

TypeScript

    import {
      getPokemon,
      getAllPokemon,
      getAllPokemonNames,
      Pokemon,
      PokemonNamesArray,
      PokemonArray }
    from 'pkmonjs';

    const poke:Pokemon = getPokemon('pikachu').then((f)=>
     {
        if(f) {
          console.log(f)
        }
     }
    )
    //or use await
    const poke:Pokemon =await getPokemon('pikachu')

    const names:PokemonNamesArray=await getAllPokemonNames()

    const pokes:PokemonArray=await getAllPokemonNames()

Response Exemple

    Pokemon{
        idPokedex: 1,
        name: 'bulbasaur',
        description: 'While it is young, it uses the nutrients that are stored in the seed on its back in order to grow.',
        sexMalePorcentage: 85,
        sexFemalePorcentage: 15,
        undefinedPorcentage: 0,
        stats: {
          hp: 45,
          attack: 49,
          defense: 49,
          specialAttack: 65,
          specialDefense: 65,
          speed: 45,
          height: 7,
          weight: 69,
          types: {
            name: [Array],
            weakness: [Object]
            }
        },
        image: {
          default: 'https://assets.pokemon.com/assets/cms2/img/pokedex/full/001.png',
            UrlMaleOrUndefined: 'https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/1.png',
            UrlShiny: 'https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/shiny/1.png'
        },
        color: {
          name: 'green',
          url: 'https://pokeapi.co/api/v2/pokemon-color/5/'
          },
        habitat: {
          name: 'grassland',
          url: 'https://pokeapi.co/api/v2/pokemon-habitat/3/'
        },
        generation: {
          name: 'generation-i',
          url: 'https://pokeapi.co/api/v2/generation/1/'
        }
}

  Names{
      { "idPokedex": 1, "pokemonName": "bulbasaur" },
      { "idPokedex": 2, "pokemonName": "ivysaur" },
      { "idPokedex": 3, "pokemonName": "venusaur" },
      { "idPokedex": 4, "pokemonName": "charmander" },
      ...
  }

  Pokemons{
    Pokemon,
    Pokemon,
    Pokemon
    ...
  }

Readme

Keywords

Package Sidebar

Install

npm i pkmonjs

Weekly Downloads

4

Version

1.6.4

License

MIT

Unpacked Size

2.31 MB

Total Files

52

Last publish

Collaborators

  • danielsguirra