Neovictorian Paisley Menswear

    pokemon
    TypeScript icon, indicating that this package has built-in type declarations

    2.3.0 • Public • Published

    pokemon

    Get Pokémon names

    The name list is just a JSON file and can be used wherever.

    Install

    $ npm install pokemon
    

    Usage

    const pokemon = require('pokemon');
    
    pokemon.all();
    //=> ['Bulbasaur', …]
    
    pokemon.random();
    //=> 'Snorlax'
    
    pokemon.getName(147);
    //=> 'Dratini'
    
    pokemon.getId('Dratini');
    //=> 147

    API

    .all(language?)

    Get all Pokémon names as a string[].

    language

    Type: string
    Default: 'en'

    Language code to retrieve the list of Pokémon for.

    pokemon.all();
    //=> ['Bulbasaur', …]
    pokemon.all('de');
    //=> ['Bisasam', …]

    .random(language?)

    Get random Pokémon name.

    language

    Type: string
    Default: 'en'

    Language code to retrieve the Pokémon for.

    pokemon.random();
    //=> 'Vigoroth'
    pokemon.random('de');
    //=> 'Muntier'

    .getName(id, language?)

    Get Pokémon name from ID.

    id

    Type: number

    The ID of a Pokémon, retrieved via getId().

    language

    Type: string
    Default: 'en'

    Language code to retrieve the Pokémon for.

    pokemon.getName(100);
    //=> 'Voltorb'
    pokemon.getName(100, 'de');
    //=> 'Voltobal'

    .getId(name, language?)

    Get Pokémon ID from name.

    name

    Type: string

    The Pokémon name in the language locale.

    language

    Type: string
    Default: 'en'

    Language code of the localized name.

    pokemon.getId('Snorlax');
    //=> 143
    pokemon.getId('Relaxo', 'de');
    //=> 143

    .languages: Set

    pokemon.languages.has('ja');
    //=> true

    Supported languages

    Pokémon names are available for the following languages:

    • de (German)
    • en (English)
    • fr (French)
    • es (Spanish)
    • ja (Japanese)
    • ko (Korean)
    • ru (Russian)
    • th (Thai)
    • zh-Hans (Simplified Chinese)
    • zh-Hant (Traditional Chinese)

    The language codes follow the IETF BCP 47 standard.

    Related

    Install

    npm i pokemon

    DownloadsWeekly Downloads

    446

    Version

    2.3.0

    License

    MIT

    Unpacked Size

    153 kB

    Total Files

    15

    Last publish

    Collaborators

    • sindresorhus