Skip to content

@valoranchi/riot-client / index / MatchesApi

Interface: MatchesApi ​

Defined in: src/client/api.ts:136

Methods ​

assess() ​

assess(puuid?): Promise<PlayerAssessment>

Defined in: src/client/api.ts:178

Parameters ​

puuid? ​

string

Returns ​

Promise<PlayerAssessment>


content() ​

content(): Promise<Content>

Defined in: src/client/api.ts:153

Returns ​

Promise<Content>


dodge() ​

dodge(options?): Promise<{ dodged: boolean; matchId: string; }>

Defined in: src/client/api.ts:163

Parameters ​

options? ​
confirm? ​

boolean

Returns ​

Promise<{ dodged: boolean; matchId: string; }>


get() ​

get(id): Promise<Match>

Defined in: src/client/api.ts:140

Parameters ​

id ​

string

Returns ​

Promise<Match>


known() ​

known(puuid?): Promise<MatchSummary[]>

Defined in: src/client/api.ts:139

Parameters ​

puuid? ​

string

Returns ​

Promise<MatchSummary[]>


leaderboard() ​

leaderboard(options?): Promise<Leaderboard>

Defined in: src/client/api.ts:147

Parameters ​

options? ​
query? ​

string

season? ​

string

size? ​

number

start? ​

number

Returns ​

Promise<Leaderboard>


leaveMatch() ​

leaveMatch(options?): Promise<{ left: boolean; matchId: string; }>

Defined in: src/client/api.ts:167

Parameters ​

options? ​
confirm? ​

boolean

Returns ​

Promise<{ left: boolean; matchId: string; }>


list() ​

list(options?): Promise<MatchSummary[]>

Defined in: src/client/api.ts:137

Parameters ​

options? ​
count? ​

number

queue? ​

string

Returns ​

Promise<MatchSummary[]>


listFor() ​

listFor(puuid, options?): Promise<MatchSummary[]>

Defined in: src/client/api.ts:144

Parameters ​

puuid ​

string

options? ​
count? ​

number

queue? ​

string

Returns ​

Promise<MatchSummary[]>


live() ​

live(options?): Promise<LiveMatch>

Defined in: src/client/api.ts:143

Parameters ​

options? ​
loadouts? ​

boolean

ranks? ​

boolean

Returns ​

Promise<LiveMatch>


lockAgent() ​

lockAgent(agent): Promise<LiveMatch>

Defined in: src/client/api.ts:159

Parameters ​

agent ​

string

Returns ​

Promise<LiveMatch>


mmr() ​

mmr(): Promise<Mmr>

Defined in: src/client/api.ts:141

Returns ​

Promise<Mmr>


mmrFor() ​

mmrFor(puuid): Promise<Mmr>

Defined in: src/client/api.ts:145

Parameters ​

puuid ​

string

Returns ​

Promise<Mmr>


premier() ​

premier(): Promise<Premier>

Defined in: src/client/api.ts:154

Returns ​

Promise<Premier>


rankHistory() ​

rankHistory(options?): Promise<RankChange[]>

Defined in: src/client/api.ts:142

Parameters ​

options? ​
count? ​

number

Returns ​

Promise<RankChange[]>


rankHistoryFor() ​

rankHistoryFor(puuid, options?): Promise<RankChange[]>

Defined in: src/client/api.ts:146

Parameters ​

puuid ​

string

options? ​
count? ​

number

Returns ​

Promise<RankChange[]>


selectAgent() ​

selectAgent(agent): Promise<LiveMatch>

Defined in: src/client/api.ts:155

Parameters ​

agent ​

string

Returns ​

Promise<LiveMatch>


summary() ​

summary(options?): Promise<PerformanceSummary>

Defined in: src/client/api.ts:172

Parameters ​

options? ​
count? ​

number

onProgress? ​

(done, total) => void

puuid? ​

string

queue? ​

string

Returns ​

Promise<PerformanceSummary>


sync() ​

sync(options?): Promise<MatchSyncResult>

Defined in: src/client/api.ts:138

Parameters ​

options? ​
maxPages? ​

number

Returns ​

Promise<MatchSyncResult>


trend() ​

trend(options?): Promise<RatingTrend>

Defined in: src/client/api.ts:171

Parameters ​

options? ​
count? ​

number

puuid? ​

string

Returns ​

Promise<RatingTrend>


validateDodge() ​

validateDodge(options?): Promise<{ matchId: string; method: string; path: string; }>

Defined in: src/client/api.ts:164

Parameters ​

options? ​
confirm? ​

boolean

Returns ​

Promise<{ matchId: string; method: string; path: string; }>


validateLeaveMatch() ​

validateLeaveMatch(options?): Promise<{ matchId: string; method: string; path: string; puuid: string; }>

Defined in: src/client/api.ts:168

Parameters ​

options? ​
confirm? ​

boolean

Returns ​

Promise<{ matchId: string; method: string; path: string; puuid: string; }>


validateLockAgent() ​

validateLockAgent(agent): Promise<{ agentUuid: string; matchId: string; method: string; path: string; }>

Defined in: src/client/api.ts:160

Parameters ​

agent ​

string

Returns ​

Promise<{ agentUuid: string; matchId: string; method: string; path: string; }>


validateSelectAgent() ​

validateSelectAgent(agent): Promise<{ agentUuid: string; matchId: string; method: string; path: string; }>

Defined in: src/client/api.ts:156

Parameters ​

agent ​

string

Returns ​

Promise<{ agentUuid: string; matchId: string; method: string; path: string; }>

Not affiliated with Riot Games