Client class

The shieldbow client that enables you to interact with Riot Games' League of Legends API. Also connects to the Data Dragon + Community Dragon CDNs.

Signature:

export declare class Client 

Constructor

new Client (apiKey: string)

Constructs a new instance of the Client class.

Parameters:

Properties

accounts

The default riot accounts manager used by the client. This is mostly for internal usage. You may want to use Client.summoners instead.

Type: AccountManager

api

The default API interactions handler used by the client.

Type: RateLimiter

cache

The client's caching utility.

Type: ICache

cacheEnabled

The client's configuration for caching. This is for internal usage only.

PLEASE DO NOT TRY TO USE THIS. Refer to Client.initialize to configure this.

Type: ManagersConfig

cdnBase

The Data Dragon CDN Base URL

Type: String

challenges

The default LOL challenges manager used by the client.

Type: ChallengeManager

champions

The default champions manager used by the client.

Type: ChampionManager

clash

The default clash tournaments manager used by the client.

Type: ClashManager

gameModes

An array of all game modes and their respective data.

Type: GameMode

gameTypes

An array of all game types and their respective data.

Type: GameType

http

The axios instance that handles all the CDN requests being made.

Type: AxiosInstance

initialized

Is this client initialized.

Type: Boolean

items

The default items manager used by the client.

Type: ItemManager

leagues

The default summoner competitive league data manager used by the client.

Highly recommended using Client.summoners for a specific summoner's competitive info.

Use this only if you want to query a list of users by rank-division.

Type: LeagueManager

locale

The locale in which all the data is going to be fetched in.

Type: "cs_CZ" | "el_GR" | "pl_PL" | "ro_RO" | "hu_HU" | "en_GB" | "de_DE" | "es_ES" | "it_IT" | "fr_FR" | "ja_JP" | "ko_KR" | "es_MX" | "es_AR" | "pt_BR" | "en_US" | "en_AU" | "ru_RU" | "tr_TR" | "ms_MY" | "en_PH" | "en_SG" | "th_TH" | "vn_VN" | "id_ID" | "zh_MY" | "zh_CN" | "zh_TW"

logger

The client's logging utility.

Type: ILogger | Undefined

maps

An array of all maps and their respective data.

Type: GameMap

matches

The default match manager used by the client.

Type: MatchManager

patch

The patch of the game currently in use.

Must be above 5.1 for proper functionality.

Type: String

queues

An array of all queue types and their respective data.

Type: Queue

region

The league of legends region from which the data is to be fetched.

Type: Region

runes

The default runes manager used by the client.

Type: RuneTreeManager

seasons

An array of all seasons and their respective IDs.

Type: Season

spectator

The default live match manager used by the client.

Type: CurrentGameManager

status

Get the current status of the RIOT API.

No type support for this (yet).

Type: Promise < unknown >

storage

The client's storage utility.

Type: IStorage

storageEnabled

The client's configuration for storage. This is for internal usage only.

PLEASE DO NOT TRY TO USE THIS. Refer to Client.initialize to configure this.

Type: ManagersConfig

summoners

The default summoners manager used by the client.

Type: SummonerManager

summonerSpells

The default summoner spells manager used by the client.

Type: SummonerSpellManager

version

The current Data Dragon CDN version.

Type: String

Methods

.initialize ()

Initialize the client to prepare it for interacting with the API. This can also be rerun if you want to configure anything and quickly fetch any required data.

Signature:

initialize(options?: ClientConfig): Promise<void>;

Parameters:

Return type: Promise < void >

.updateLocale ()

Update the locale in which the data is fetched.

Signature:

updateLocale(newLocale: Locales, refetch?: boolean): Promise<void>;

Parameters:

Return type: Promise < void >

.updatePatch ()

Update the patch from which the data is fetched.

NOTE: The patch must be 2 integers separated by a .. For example: 10.11 or 12.9.

This should NOT be the data dragon version.

Signature:

updatePatch(patch: string, refetch?: boolean): Promise<void>;

Parameters:

Return type: Promise < void >