Skip to main content

clashofclans.js

Classes​

Interfaces​

Type Aliases​

ResponseBody​

Ƭ ResponseBody: any

Defined in​

rest/RequestHandler.ts:51

Variables​

PrivateWarLogError​

• Const PrivateWarLogError: Object

Type declaration​

NameType
messagestring
reasonstring

Defined in​

rest/HTTPError.ts:57

APIBaseURL​

• Const APIBaseURL: "https://api.clashofclans.com/v1"

Defined in​

util/Constants.ts:3

DevSiteAPIBaseURL​

• Const DevSiteAPIBaseURL: "https://developer.clashofclans.com/api"

Defined in​

util/Constants.ts:4

SuperTroops​

• Const SuperTroops: string[]

Defined in​

util/Constants.ts:6

ElixirTroops​

• Const ElixirTroops: string[]

Defined in​

util/Constants.ts:8

DarkElixirTroops​

• Const DarkElixirTroops: string[]

Defined in​

util/Constants.ts:12

HomeTroops​

• Const HomeTroops: string[]

Defined in​

util/Constants.ts:16

SiegeMachines​

• Const SiegeMachines: string[]

Defined in​

util/Constants.ts:18

HeroEquipment​

• Const HeroEquipment: string[]

Defined in​

util/Constants.ts:20

ElixirSpells​

• Const ElixirSpells: string[]

Defined in​

util/Constants.ts:22

DarkElixirSpells​

• Const DarkElixirSpells: string[]

Defined in​

util/Constants.ts:26

Spells​

• Const Spells: string[]

Defined in​

util/Constants.ts:30

BuilderTroops​

• Const BuilderTroops: string[]

Defined in​

util/Constants.ts:32

Heroes​

• Const Heroes: string[]

Defined in​

util/Constants.ts:36

HeroPets​

• Const HeroPets: string[]

Defined in​

util/Constants.ts:38

UnrankedLeagueData​

• Const UnrankedLeagueData: Object

Type declaration​

NameType
idnumber
namestring
iconUrls{ small: string = 'https://api-assets.clashofclans.com/leagues/72/e--YMyIexEQQhE4imLoJcwhYn6Uy8KqlgyY3\_kFV6t4.png'; tiny: string = 'https://api-assets.clashofclans.com/leagues/36/e--YMyIexEQQhE4imLoJcwhYn6Uy8KqlgyY3\_kFV6t4.png' }
iconUrls.smallstring
iconUrls.tinystring

Defined in​

util/Constants.ts:40

UnrankedLeagueId​

• Const UnrankedLeagueId: 29000000

Defined in​

util/Constants.ts:49

LegendLeagueId​

• Const LegendLeagueId: 29000022

Defined in​

util/Constants.ts:50

UnrankedWarLeagueId​

• Const UnrankedWarLeagueId: 48000000

Defined in​

util/Constants.ts:51

Leagues​

• Const Leagues: number[]

Defined in​

util/Constants.ts:53

WarLeagues​

• Const WarLeagues: number[]

Defined in​

util/Constants.ts:79

FriendlyWarPreparationTimes​

• Const FriendlyWarPreparationTimes: readonly [number, number, number, number, number, number, number, number, number, number, number, number]

Defined in​

util/Constants.ts:84

PollingEvents​

• Const PollingEvents: Object

Type declaration​

NameType
ClanLoopStart"clanLoopStart"
ClanLoopEnd"clanLoopEnd"
PlayerLoopStart"playerLoopStart"
PlayerLoopEnd"playerLoopEnd"
WarLoopStart"warLoopStart"
WarLoopEnd"warLoopEnd"
NewSeasonStart"newSeasonStart"
MaintenanceStart"maintenanceStart"
MaintenanceEnd"maintenanceEnd"
Error"error"
Debug"debug"

Defined in​

util/Constants.ts:99

ClientEvents​

• Const ClientEvents: Object

Type declaration​

NameType
Error"error"
Debug"debug"

Defined in​

util/Constants.ts:113

RestEvents​

• Const RestEvents: Object

Type declaration​

NameType
Error"error"
Debug"debug"
RateLimited"rateLimited"

Defined in​

util/Constants.ts:118

CWLRounds​

• Const CWLRounds: Object

Type declaration​

NameType
PreviousRound"warEnded"
CurrentRound"inWar"
NextRound"preparation"

Defined in​

util/Constants.ts:124

RawData​

• Const RawData: Object

Type declaration​

NameType
RawUnits({ tid: string = "TID_BARBARIAN"; id: number = 0; name: string = "Barbarian"; housingSpace: number = 1; village: string = "home"; category: string = "troop"; subCategory: string = "troop"; unlock: { hall: number = 1; cost: number = 100; time: number = 10; resource: string = "Elixir"; building: string = "Barracks"; buildingLevel: number = 1 } ; trainingTime: number = 5; regenerationTimes: never[] = []; dps: number[] ; upgrade: { cost: number[] ; time: number[] ; resource: string = "Elixir"; resources: never[] = [] } ; allowedCharacters: never[] = []; minLevel: number = 1; seasonal: boolean = false; levels: number[] ; resourceType?: undefined = "Elixir" } | { tid: string = "TID_RAGED_BARBARIAN"; id: number = 31; name: string = "Raged Barbarian"; housingSpace: number = 4; village: string = "builderBase"; category: string = "troop"; subCategory: string = "troop"; unlock: { hall: number = 1; cost: number = 1000; time: number = 0; resource: string = "Builder Elixir"; building: string = "Builder Barracks"; buildingLevel: number = 1 } ; trainingTime: string = ""; regenerationTimes: never[] = []; dps: number[] ; upgrade: { cost: number[] ; time: number[] ; resource: string = "Builder Elixir"; resources: never[] = [] } ; allowedCharacters: never[] = []; minLevel: number = 1; seasonal: boolean = false; levels: number[] ; resourceType?: undefined = "Elixir" } | { tid: string = "TID_BARBARIAN_KING"; id: number = 0; name: string = "Barbarian King"; housingSpace: number = 25; village: string = "home"; category: string = "hero"; subCategory: string = "hero"; unlock: { hall: number = 7; cost: number = 0; time: number = 0; resource: string = "Dark Elixir"; building: string = "Barbarian King"; buildingLevel: number = 1 } ; resourceType: string = "Elixir"; trainingTime: number = 0; regenerationTimes: number[] ; dps: number[] ; upgrade: { cost: number[] ; time: number[] ; resource: string = "Dark Elixir"; resources: never[] = [] } ; allowedCharacters: never[] = []; minLevel: number = 1; seasonal: boolean = false; levels: number[] } | { tid: string = "TID_GEAR_TITLE_IRON_FIST"; id: number = 1; name: string = "Rage Vial"; housingSpace: number = 0; village: string = "home"; category: string = "equipment"; subCategory: string = "equipment"; unlock: { hall: number = 8; cost: number = 750000; time: number = 86400; resource: string = "Elixir"; building: string = "Blacksmith"; buildingLevel: number = 1 } ; trainingTime: number = 0; regenerationTimes: never[] = []; dps: number[] ; upgrade: { cost: number[] ; time: never[] = []; resource: string = "Shiny Ore"; resources: { resource: string = "Shiny Ore"; cost: number = 120 }[][] } ; allowedCharacters: string[] ; minLevel: number = 1; seasonal: boolean = false; levels: number[] ; resourceType?: undefined = "Elixir" })[]
RawSuperUnits{ name: string = "Super Barbarian"; id: number = 26; original: string = "Barbarian"; minOriginalLevel: number = 8; village: string = "home"; duration: number = 259200; cooldown: number = 259200; resource: string = "Dark Elixir"; resourceCost: number = 25000; housingSpace: number = 5 }[]

Defined in​

util/Constants.ts:130

Functions​

timeoutSignal​

▸ timeoutSignal(timeout): AbortSignal

Parameters​

NameType
timeoutnumber

Returns​

AbortSignal

Defined in​

util/Util.ts:20

calculateRaidsCompleted​

▸ calculateRaidsCompleted(attackLog): number

Parameters​

NameType
attackLogAPICapitalRaidSeasonAttackLog[]

Returns​

number

Defined in​

util/Helper.ts:4

calculateOffensiveRaidMedals​

▸ calculateOffensiveRaidMedals(attackLog): number

Parameters​

NameType
attackLogAPICapitalRaidSeasonAttackLog[]

Returns​

number

Defined in​

util/Helper.ts:12

isFriendlyWar​

▸ isFriendlyWar(preparationStartTime, startTime): boolean

Parameters​

NameType
preparationStartTimeDate
startTimeDate

Returns​

boolean

Defined in​

util/Helper.ts:50

getWarResult​

▸ getWarResult(clan, opponent): "win" | "lose" | "tie"

Parameters​

NameType
clanPartialWarClan
opponentPartialWarClan

Returns​

"win" | "lose" | "tie"

Defined in​

util/Helper.ts:55

isWarWinner​

▸ isWarWinner(clan, opponent): boolean

Parameters​

NameType
clanPartialWarClan
opponentPartialWarClan

Returns​

boolean

Defined in​

util/Helper.ts:64