Class League

Hierarchy

League

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new League(api: ClashAPI, data: APILeague): League

- Defined in Structures/League.ts:10
Creates a new League instance

Parameters
- api: ClashAPI
  
  Reference to ClashAPI instance
- data: APILeague
  
  APILeague data
Returns League

Properties

Private api

iconUrls

iconUrls: object

Type declaration

medium: string
small: string
tiny: string

id

id: number

name

name: string

Methods

fetchSeason

fetchSeason(seasonId: string): Promise<LeagueSeason>

- Defined in Structures/League.ts:60
Get league season rankings. Note that league season information is available only for Legend League.

Parameters
- seasonId: string
  
  Identifier of the season.
Returns Promise<LeagueSeason>

fetchSeasons

fetchSeasons(limit?: number, after?: string, before?: string): Promise<LeagueSeason[]>

- Defined in Structures/League.ts:33
Get league seasons. Note that league season information is available only for Legend League.

Parameters
- Optional limit: number
- Optional after: string
- Optional before: string
Returns Promise<LeagueSeason[]>

Made by Horyus. Documentation generated by TypeDoc.