Skip to main content

Class: Club

The entity which we use to construct every club entry.

Hierarchy​

  • Structure

    ↳ Club

Constructors​

constructor​

• new Club(data)

Parameters​

NameType
dataOmit<IClub, "members">

Overrides​

Structure.constructor

Defined in​

lib/structures/Club.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


badgeId​

• badgeId: number

Defined in​

lib/structures/Club.ts:12


description​

• description: string

Defined in​

lib/structures/Club.ts:10


members​

• members: MembersEntity[]

Defined in​

lib/structures/Club.ts:15


name​

• name: string

Defined in​

lib/structures/Club.ts:9


requiredTrophies​

• requiredTrophies: number

Defined in​

lib/structures/Club.ts:13


tag​

• tag: string

Defined in​

lib/structures/Club.ts:8


trophies​

• trophies: number

Defined in​

lib/structures/Club.ts:14


type​

• type: "open" | "closed"

Defined in​

lib/structures/Club.ts:11

Methods​

request​

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

Type parameters​

Name
T

Parameters​

NameType
endpointstring
tokenstring

Returns​

Promise<T>

Inherited from​

Structure.request

Defined in​

lib/structures/Structure.ts:10