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

1.1.4 • Public • Published

lol-champs

Art By❤️ QUIRKILICIOUS

Build Status Node Version Jest Prettier Downloads License

Get champion names of League of Legends

Install

$ npm install lol-champs

Usage

// ES6
import * as lolChamps from 'lol-champs';
 
// CommonJS
const lolChamps = require('lol-champs');
 
lolChamps.random();
//=> 'Random champion name' ex) Darius
 
lolChamps.all();
//=> ['Wukong', 'Jax', ...]
 
lolChamps.getChampion();
//=> { title: 'the Grand Duelist', id: 114, key: 'Fiora', name: 'Fiora' }
 
lolChamps.getName(222);
//=> 'Jinx'
 
lolChamps.getId('Ezreal');
//=> 81

API

.all(lang: string = 'en') : string[]

Get a list of entire names.

lang

Language code to retrieve the list of champion names.

lolChamps.all();
//=> ['Wukong', 'Jax', ...]
 
lolChamps.all('zh-hans');
//=> ['齐天大圣', '武器大师', ...]

.getChampion(name: string, lang: string = 'en') : object

Get champion data by using name.

lang

Language code to retrieve the champion data.

lolChamps.getChampion('Cassiopeia');
//=> { title: 'the Serpent's Embrace', id: 69, key: 'Cassiopeia', name: 'Cassiopeia'},
 
lolChamps.getChampion('Ли Син', 'ru');
//=> { title: 'Слепой монах', id: 64, key: 'LeeSin', name: 'Ли Син' }

.random(lang: string = 'en') : string

Get a random champion name that's never the same as the previous.

lolChamps.random();
lolChamps.random();
//=> 'Fizz'
//=> 'Thresh'
 
lolChamps.random('ko');
lolChamps.random('ko');
//=> '야스오'
//=> '티모'
 
lolChamps.random('zh-hans');
lolChamps.random('zh-hans');
//=> '蒸汽机器人'
//=> '时间刺客'
 
lolChamps.random('ru');
lolChamps.random('ru');
//=> 'Катарина'
//=> 'Пантеон'
 
lolChamps.random('ja');
lolChamps.random('ja');
//=> 'トリスターナ'
//=> 'ソラカ'

.getName(champId: number, lang: string = 'en') : string

Get champion name by using ID.

lang

Language code to retrieve the name of champion.

lolChamps.getName(35);
//=> 'Shaco'
 
lolChamps.getName(35, 'ko');
//=> '샤코'

.getId(name: string, lang: string = 'en') : string

Get champion ID by using name.

lang

Language code of the localized name.

lolChamps.getId('Amumu');
//=> '32'
 
lolChamps.getId("Амуму", 'ru');
//=> '32'

.languages : Set

Check supported languages.

lolChamps.languages.has('de');
//=> true

Supported languages

Champion names are available for the following languages:

  • cs (Czech)
  • de (German)
  • el (Greek)
  • en (English)
  • fr (French)
  • hu (Hungalian)
  • it (Italian)
  • ja (Japanese)
  • ko (Korean)
  • pl (Polish)
  • pt (Portuguese)
  • ru (Russian)
  • tr (Turkish)
  • vn (Vietnamese)
  • zh-hans (Simplified Chinese)
  • zh-hant (Traditional Chinese)

The language codes follow the IETF BCP 47 standard.

License

MIT © JeffMinsungKim

Package Sidebar

Install

npm i lol-champs

Weekly Downloads

3

Version

1.1.4

License

MIT

Unpacked Size

292 kB

Total Files

21

Last publish

Collaborators

  • jeffminsungkim