@cfwest/ranking
Install using
npm install @cfwest/ranking
You can access these members by importing the module:
import { member } from '@cfwest/ranking';
ClanRankingModule
class
ClanRankingModule
No docs provided
constructor
function
(
)
:
any
No docs provided
public getClanRanking (...)
function getClanRanking
(
options
:
RankingOptions
= { rank: RankType.Clan }
)
:
Promise<ClanInfo[] | undefined>
No docs provided
public searchClan (...)
function searchClan
(
name
:
string
,
period
:
PeriodType
= PeriodType.AllTime
)
:
Promise<ClanInfo[] | undefined>
No docs provided
ClanInfo
interface
ClanInfo
No docs provided
id
Type:
number
No docs provided
clankey
Type:
number
No docs provided
clanname
Type:
string
No docs provided
marklayer01
Type:
number
No docs provided
marklayer02
Type:
number
No docs provided
marklayer03
Type:
number
No docs provided
marklayer04
Type:
number
No docs provided
xp_point
Type:
number
No docs provided
rank
Type:
number
No docs provided
regweek
Type:
string
No docs provided
startdate
Type:
number
No docs provided
enddate
Type:
number
No docs provided
pattern
Type:
string
No docs provided
ClanRankingResponse
interface
ClanRankingResponse
No docs provided
Ranking
Type:
ClanRanking
No docs provided
ClanRanking
interface
ClanRanking
No docs provided
RankList
Type:
ClanInfo[]
No docs provided
RankingModule
class
RankingModule
No docs provided
constructor
function
(
)
:
any
No docs provided
public readonly playerRanking
Type:
PlayerRankingModule
No docs provided
public readonly clanRanking
Type:
ClanRankingModule
No docs provided
PlayerRankingModule
class
PlayerRankingModule
No docs provided
constructor
function
(
)
:
any
No docs provided
public searchPlayer (...)
function searchPlayer
(
name
:
string
,
period
:
PeriodType
= PeriodType.AllTime
)
:
Promise<PlayerInfo[] | undefined>
No docs provided
public getPlayerRanking (...)
function getPlayerRanking
(
options
:
RankingOptions
= {}
)
:
Promise<PlayerInfo[] | undefined>
No docs provided
PlayerRankingResponse
interface
PlayerRankingResponse
No docs provided
Ranking
Type:
PlayerRanking
No docs provided
PlayerRanking
interface
PlayerRanking
No docs provided
RankList
Type:
PlayerInfo[]
No docs provided
PlayerInfo
interface
PlayerInfo
No docs provided
id
Type:
number
No docs provided
usn
Type:
number
No docs provided
ign
Type:
string
No docs provided
xp_point
Type:
number
No docs provided
total_xp
Type:
number
No docs provided
game_point
Type:
number
No docs provided
rank
Type:
number
No docs provided
regweek
Type:
string
No docs provided
startdate
Type:
number
No docs provided
enddate
Type:
number
No docs provided
name
Type:
string
No docs provided
rank_title
Type:
string
No docs provided
position
Type:
number
No docs provided
isMarshal
Type:
boolean
No docs provided
kills
Type:
null
No docs provided
deaths
Type:
null
No docs provided
wins
Type:
null
No docs provided
games
Type:
number
No docs provided
kd
Type:
number
No docs provided
vit
Type:
string
No docs provided