json-pokemon

json-pokemon

This package includes list of all pokemons. Original data is available on https://pokemondb.net/pokedex/national.

Install

To install this package use

npm install --save json-pokemon

Usage

require command just returns a list of pokemon objects. The format is next:

const pokemons = require('json-pokemon');

const pokemon = pokemons[0];
// pokemon's structure:
// {
//   id: 1,
//   name: 'some-pokemon-name',
//   typeList: ['Fire', 'Grass']
// }

Possible usage

const getPokemons = require('json-pokemon/getPokemon');

const pokemons = getPokemons(); // See API in the next section.
const firstPokemon = getPokemons.getPokemonById(1); // See API in the next section.
const snow = getPokemons.getPokemonByName('snow'); // See API in the next section.

API

Table of Contents

• Pokemon
  • Properties
• getPokemonById
  • Parameters
• getPokemonByName
  • Parameters
• getPokemon
  • Parameters

Pokemon

Pokemon's type.

Type: object

Properties

• id number Pokemon's id.
• name string Pokemon's name.
• typeList Array<string> Pokemon's types.

getPokemonById

Returns pokemon found by its id.

Parameters

• id number Pokemon's id.

Returns (Pokemon | null) Pokemon if founded, else returns null.

getPokemonByName

Returns pokemon found by its name.

Parameters

• name string Pokemon's id.

Returns (Pokemon | null) Pokemon if founded, else returns null.

getPokemon

Returns list of pokemons filtered with passed info.

Parameters

• filter object Filter descriptor. (optional, default {})
  • filter.type (Array<string> | string | null) Types of pokemons to returns. If type is null, skip this filter. If type is string, returns list of pokemons which has this type. If type is an array, returns list of pokemons which has all of types. (optional, default null)

Returns Array<Pokemon> List of filtered pokemons.