pokeapi-ts

An API Wrapper for pokeapi written in typescript

Usage no npm install needed!

<script type="module">
  import pokeapiTs from 'https://cdn.skypack.dev/pokeapi-ts';
</script>

README

Pokeapi-ts

An API Wrapper for pokeapi written in typescript

Version Downloads/week License

Installing

A step by step series of examples that tell you how to get the package

$ npm i pokeapi-ts --save

or

$ yarn add pokeapi-ts

Documentation

Check all the methods available on the docs

Usage

The packages wrap all methods of the V2 API

Here's an example on how to use the package

  const PokeAPI = require('pokeapi-ts').default
  const Pokedex = new PokeAPI()

  Pokedex.getStats(5)
    .then(data => console.log(data))
    .catch(err => console.error(err))

  Pokedex.getStats(5) // This will be auto cached
    .then(data => console.log(data))
    .catch(err => console.error(err))

For a full list of all available methods please check the Documentation section

Built With

  • Typescript - Typed superset of JavaScript
  • Typedoc - Documentation generator for typescript projects
  • Axios - Promise based HTTP client for the browser and node.js
  • Axios-Extensions - Used to cache requests

License

This project is licensed under the MIT License