lol-constants
Version:
League of Legends constants, functions, and types. Provides a plathera of functions to easily convert between ID, Name, and Key for champions, items, summoner spells, and runes.
140 lines (139 loc) • 3.42 kB
TypeScript
export declare const Regions: {
readonly BR: {
readonly region: "BR";
readonly platform: "BR1";
};
readonly EUNE: {
readonly region: "EUNE";
readonly platform: "EUN1";
};
readonly EUW: {
readonly region: "EUW";
readonly platform: "EUW1";
};
readonly JP: {
readonly region: "JP";
readonly platform: "JP1";
};
readonly KR: {
readonly region: "KR";
readonly platform: "KR";
};
readonly LAN: {
readonly region: "LAN";
readonly platform: "LA1";
};
readonly LAS: {
readonly region: "LAS";
readonly platform: "LA2";
};
readonly NA: {
readonly region: "NA";
readonly platform: "NA1";
};
readonly OCE: {
readonly region: "OCE";
readonly platform: "OC1";
};
readonly TR: {
readonly region: "TR";
readonly platform: "TR1";
};
readonly RU: {
readonly region: "RU";
readonly platform: "RU";
};
readonly PH: {
readonly region: "PH";
readonly platform: "PH2";
};
readonly SG: {
readonly region: "SG";
readonly platform: "SG2";
};
readonly TH: {
readonly region: "TH";
readonly platform: "TH2";
};
readonly TW: {
readonly region: "TW";
readonly platform: "TW2";
};
readonly VN: {
readonly region: "VN";
readonly platform: "VN2";
};
readonly MENA: {
readonly region: "MENA";
readonly platform: "ME1";
};
readonly PBE: {
readonly region: "PBE";
readonly platform: "PBE1";
};
};
export declare const RegionsArr: ({
readonly region: "BR";
readonly platform: "BR1";
} | {
readonly region: "EUNE";
readonly platform: "EUN1";
} | {
readonly region: "EUW";
readonly platform: "EUW1";
} | {
readonly region: "JP";
readonly platform: "JP1";
} | {
readonly region: "KR";
readonly platform: "KR";
} | {
readonly region: "LAN";
readonly platform: "LA1";
} | {
readonly region: "LAS";
readonly platform: "LA2";
} | {
readonly region: "NA";
readonly platform: "NA1";
} | {
readonly region: "OCE";
readonly platform: "OC1";
} | {
readonly region: "TR";
readonly platform: "TR1";
} | {
readonly region: "RU";
readonly platform: "RU";
} | {
readonly region: "PH";
readonly platform: "PH2";
} | {
readonly region: "SG";
readonly platform: "SG2";
} | {
readonly region: "TH";
readonly platform: "TH2";
} | {
readonly region: "TW";
readonly platform: "TW2";
} | {
readonly region: "VN";
readonly platform: "VN2";
} | {
readonly region: "MENA";
readonly platform: "ME1";
} | {
readonly region: "PBE";
readonly platform: "PBE1";
})[];
export type Region = typeof RegionsArr[number]['region'];
export type Platform = typeof RegionsArr[number]['platform'];
export declare function isRegion(region: string | null | undefined): region is Region;
export declare function isPlatform(platform: string | null | undefined): platform is Platform;
/**
* Get region by its region notation (e.g. `'EUW'`)
* or by its platform notation (e.g. `'EUW1'`).
* Convert between the two.
*/
export declare function getRegion(region_platform: Region | Platform): typeof Regions[keyof typeof Regions];