EmmaRamirez / pokemon

📇 Get pokemon names.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Pokémon premierball

Travis Crates.io contributions

A tiny Rust library inspired by Pokémon, that lets you get Pokémon names.

Notes

This project is not yet complete and is highly unstable and half-written. Do not use it in production, although it'd be weird if your production needed Pokémon names, but, uh, yeah.

Installation

cargo install pokemon

API

Notes

Currently, Pokémon are limited to the following properties:

Property Type
species i32
language i32
name String
genus Option<String>

Languages correspond to these ids:

id language
1 Japanese (literal)
2 Japanese (transliterated)
3 Korean
4 Chinese
5 French
6 German
7 Spanish
8 Italian
9 English

pokemon::get_all()

Returns a vector of Pokemon.

pokemon::get_pokemon(id, lang)

Returns a Pokémon based on the specified id and language.

pokemon::get_random()

Returns a random Pokémon.

pokemon::get_random_with_lang()

Returns a random Pokémon, with a specified language.

pokemon::get_name(id)

Returns the name of a Pokémon based on its id. (In English).

pokemon::get_name_with_lang(id, lang)

Returns the name of a Pokémon, given id and language.

About

📇 Get pokemon names.

License:MIT License


Languages

Language:Rust 100.0%