Class: Leaderboard

The entity which we use to construct every leaderboard entry.

Hierarchy

• Structure

  ↳ Leaderboard

Constructors

constructor

• new Leaderboard(options)

Parameters

Name	Type
options	Omit<Leaderboard, "constructor">

Overrides

Structure.constructor

Defined in

lib/structures/Leaderboard.ts:17

Properties

#endpoint

• Private #endpoint: string

Inherited from

Structure.#endpoint

Defined in

lib/structures/Structure.ts:5

---

#url

• Private #url: string = 'https://bsproxy.royaleapi.dev/v1'

Inherited from

Structure.#url

Defined in

lib/structures/Structure.ts:4

---

club

• club: PlayerClub

Defined in

lib/structures/Leaderboard.ts:15

---

icon

• icon: Icon

Defined in

lib/structures/Leaderboard.ts:12

---

name

• name: string

Defined in

lib/structures/Leaderboard.ts:10

---

nameColor

• nameColor: string

Defined in

lib/structures/Leaderboard.ts:11

---

rank

• rank: number

Defined in

lib/structures/Leaderboard.ts:14

---

tag

• tag: string

Defined in

lib/structures/Leaderboard.ts:9

---

trophies

• trophies: number

Defined in

lib/structures/Leaderboard.ts:13

Methods

request

▸ request<T>(endpoint?, token?): Promise<T>

Type parameters

Name
T

Parameters

Name	Type
endpoint	string
token	string

Returns

Promise<T>

Inherited from

Structure.request

Defined in

lib/structures/Structure.ts:10