Pokenode-ts

Pokenode-ts is a lightweight Node.js wrapper for the PokéAPI with built-in types. It provides an easy way to integrate your application with the PokéAPI.

Features

• 🛠️ Built-in typings: TypeScript support with pre-defined types.
• 📦 Axios with auto-cache requests: Efficiently manage API requests with automatic caching.
• 🌲 Logging: Easily log and track your API interactions.

Installation

# NPM
npm install axios axios-cache-interceptor pokenode-ts

# Yarn
yarn add axios axios-cache-interceptor pokenode-ts

# Pnpm
pnpm add axios axios-cache-interceptor pokenode-ts

Basic Example

Using a client, like PokemonClient:

import { PokemonClient } from 'pokenode-ts';

(async () => {
  const api = new PokemonClient();

  try {
    const pokemonData = await api.getPokemonByName('luxray');
    console.log(pokemonData.name); // Outputs "Luxray"
  } catch (error) {
    console.error(error);
  }
})();

Or, using the MainClient:

import { MainClient } from 'pokenode-ts';

(async () => {
  const api = new MainClient();

  try {
    const pokemonData = await api.pokemon.getPokemonByName('luxray');
    console.log(pokemonData.name); // Outputs "Luxray"
  } catch (error) {
    console.error(error);
  }
})();

Documentation

Check out our Documentation page!

Security

Every change in this project is analyzed by SonarCloud

Leave your feedback

• Did you like pokenode-ts? Give us a star ⭐
• Found a problem? Let us know by creating an issue 🔎
• Want to contribute? Submit a PR 📑

Donate

If pokenode-ts is valuable to you, please consider buying me a coffee ❤️