Skip to content

Gabb-c/pokenode-ts

Repository files navigation

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

import { PokemonClient } from 'pokenode-ts'; // Import the Client

const pokemon = await api.getPokemonByName('luxray') // Make the request
  .catch(() => console.log("Oops!"));

console.log(pokemon.name); // Typesafe response ✨ (Outputs "Luxray")

Documentation

Check out our Documentation page!

Security

Every change in this project is analyzed by SonarCloud

Quality Gate Status Bugs Code Smells Quality Gate Status codecov

Leave your feedback

Donate

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

Analytics