Class Clan

Hierarchy

Clan

Index

Constructors

constructor

Methods

Constructors

constructor

new Clan(api: ClashAPI, data: APIClan): Clan

- Defined in Structures/Clan.ts:37
Creates a new Clan instance

Parameters
- api: ClashAPI
  
  Reference to ClashAPI instance
- data: APIClan
  
  APIClan data
Returns Clan

Properties

Private api

badgeUrls

badgeUrls: object

Type declaration

large: string
medium: string
small: string

Optional chatLanguage

chatLanguage: Language

clanLevel

clanLevel: number

clanPoints

clanPoints: number

clanVersusPoints

clanVersusPoints: number

Optional description

description: string

isWarLogPublic

isWarLogPublic: boolean

labels

labels: Label[] = []

Optional location

location: Location

memberList

memberList: Map<string, ClanMember> = ...

members

members: number

name

name: string

requiredTownhallLevel

requiredTownhallLevel: number

requiredTrophies

requiredTrophies: number

requiredVersusTrophies

requiredVersusTrophies: number

tag

tag: string

type

type: string

warFrequency

warFrequency: string

Optional warLeague

warLeague: WarLeague

Optional warLosses

warLosses: number

Optional warTies

warTies: number

warWinStreak

warWinStreak: number

warWins

warWins: number

Methods

fetchClanWarLeagueWar

fetchClanWarLeagueWar(warTag: string): Promise<ClanWarLeagueGroup>

- Defined in Structures/Clan.ts:174
Retrieve information about individual clan war league war

Parameters
- warTag: string
  
  Tag of the war
Returns Promise<ClanWarLeagueGroup>

fetchCurrentWar

fetchCurrentWar(): Promise<ClanWar>

- Defined in Structures/Clan.ts:140
Retrieve information about clan's current clan war

Returns Promise<ClanWar>

fetchCurrentWarLeagueGroup

fetchCurrentWarLeagueGroup(): Promise<unknown>

- Defined in Structures/Clan.ts:156
Retrieve information about clan's current clan war league group

Returns Promise<unknown>

fetchMembers

fetchMembers(): Promise<Map<string, ClanMember>>

- Defined in Structures/Clan.ts:118
List clan members.

Returns Promise<Map<string, ClanMember>>

fetchWarLog

fetchWarLog(): Promise<ClanWarLogEntry[]>

- Defined in Structures/Clan.ts:95
Retrieve clan's clan war log

Returns Promise<ClanWarLogEntry[]>

Made by Horyus. Documentation generated by TypeDoc.