Class ErApi

Index

Constructors

Properties

fetcher getFreeCharacters getLeaderboard getMatchesByMatchId getMatchesByUserId getMetaData getMetaTypes getRankByUserId getRecommendedRoutes getRoute getTranslationPath getUser getUserByNickname queue?

Methods

createRateLimitedFunction

Constructors

constructor

new ErApi(apiKey?, options?): ErApi
Parameters
- apiKey: string = ...
- options: {
  fetcherOptions?: KyOptions;
  queue?: ErApiQueue;
  } = ...
  - Optional fetcherOptions?: KyOptions
  - Optional queue?: ErApiQueue
Returns ErApi
- Defined in packages/er-api/src/api/index.ts:120

Properties

fetcher

fetcher: KyInstance

getFreeCharacters

getFreeCharacters: ((this, matchMode) => Promise<ErFreeCharactersResponse>) = ...

Type declaration

- (this, matchMode): Promise<ErFreeCharactersResponse>
- Get free to play character ids in specific game mode
  Parameters
  - this: ErApi
    ErApi
  - matchMode: ErMatchModes
    The mode to query free to play characters
  Returns Promise<ErFreeCharactersResponse>
  An array list of character ids

getLeaderboard

getLeaderboard: ((this, seasonId, matchmakingTeamType) => Promise<ErLeaderboardResponse>) = ...

Type declaration

- (this, seasonId, matchmakingTeamType): Promise<ErLeaderboardResponse>
- Get the leaderboard data
  Parameters
  - this: ErApi
    ErApi
  - seasonId: number
    The season id to query; current latest is 23
  - matchmakingTeamType: ErMatchmakingTeamTypes
    The match making team type
  Returns Promise<ErLeaderboardResponse>
  An array of user rank data with their mmr

getMatchesByMatchId

getMatchesByMatchId: ((this, matchId, next?) => Promise<ErMatchByUserIdResponse>) = ...

Type declaration

- (this, matchId, next?): Promise<ErMatchByUserIdResponse>
- Get match data in each participated user's perspective by the given match id
  Parameters
  - this: ErApi
    ErApi
  - matchId: number
    The match id
  - Optional next: number
    An optional pagination parameter can be retrieved by a previous request
  Returns Promise<ErMatchByUserIdResponse>
  An array of match data in each participated user's perspective

getMatchesByUserId

getMatchesByUserId: ((this, userId, next?) => Promise<ErMatchByUserIdResponse>) = ...

Type declaration

- (this, userId, next?): Promise<ErMatchByUserIdResponse>
- Get matches joined by the user
  Parameters
  - this: ErApi
    ErApi
  - userId: number
    The user id to query matches
  - Optional next: number
    An optional pagination parameter can be retrieved by a previous request
  Returns Promise<ErMatchByUserIdResponse>
  An array of the match joined by the user

getMetaData

getMetaData: (<T>(this, type, version?) => Promise<ErMetaDataResponse<T>>) = ...

Type declaration

- <T>(this, type, version?): Promise<ErMetaDataResponse<T>>
- Get static data for the given metadata namespace
  Type Parameters
  - T extends ErMetaData
  Parameters
  - this: ErApi
    ErApi
  - type: ErMetaTypes
    The static data type to query
  - version: 1 | 2 = 2
    The metadata version; version 1 is deprecated
  Returns Promise<ErMetaDataResponse<T>>
  An array of constants in the specific metadata namespace

getMetaTypes

getMetaTypes: ((this, version?) => Promise<ErMetaTypesResponse>) = ...

Type declaration

- (this, version?): Promise<ErMetaTypesResponse>
- Get available keys for the metadata
  Parameters
  - this: ErApi
    ErApi
  - version: 1 | 2 = 2
    The metadata version; version 1 is deprecated
  Returns Promise<ErMetaTypesResponse>
  An array list of the static data of the game

getRankByUserId

getRankByUserId: ((this, userId, seasonId, matchmakingTeamType) => Promise<ErRankResponse>) = ...

Type declaration

- (this, userId, seasonId, matchmakingTeamType): Promise<ErRankResponse>
- Get a user rank data
  Parameters
  - this: ErApi
    ErApi
  - userId: number
    The user id to query
  - seasonId: number
    The season id to query; current latest is 23
  - matchmakingTeamType: ErMatchmakingTeamTypes
    The match making team type
  Returns Promise<ErRankResponse>
  A user rank data with their mmr

getRecommendedRoutes

getRecommendedRoutes: ((this, next?) => Promise<ErRecommendedRoutesResponse>) = ...

Type declaration

- (this, next?): Promise<ErRecommendedRoutesResponse>
- Get recommended routes
  Parameters
  - this: ErApi
    ErApi
  - Optional next: number
    An optional pagination parameter can be retrieved by a previous request
  Returns Promise<ErRecommendedRoutesResponse>
  An array of recommended routes

getRoute

getRoute: ((this, routeId) => Promise<ErRouteResponse>) = ...

Type declaration

- (this, routeId): Promise<ErRouteResponse>
- Get a route by id
  Parameters
  - this: ErApi
    ErApi
  - routeId: number
    The route id to query
  Returns Promise<ErRouteResponse>
  The route with its data

getTranslationPath

getTranslationPath: ((this, language) => Promise<ErTranslationResponse>) = ...

Type declaration

- (this, language): Promise<ErTranslationResponse>
- Get the path to translation path
  Parameters
  - this: ErApi
    ErApi
  - language: ErLanguages
    The language to query translation path
  Returns Promise<ErTranslationResponse>
  The path to translation text file encoded in UTF8

getUser

getUser: ((this, id, season?) => Promise<ErUserResponse>) = ...

Type declaration

- (this, id, season?): Promise<ErUserResponse>
- Get user stats by id
  Parameters
  - this: ErApi
    ErApi
  - id: number
    The user id
  - season: number = 0
    The season id; zero for normal game mode
  Returns Promise<ErUserResponse>
  The user stats for the given season

getUserByNickname

getUserByNickname: ((this, nickname) => Promise<ErUserIdByNicknameResponse>) = ...

Type declaration

- (this, nickname): Promise<ErUserIdByNicknameResponse>
- Get the nickname of the user by their id
  Parameters
  - this: ErApi
    ErApi
  - nickname: string
    The nickname of the user
  Returns Promise<ErUserIdByNicknameResponse>
  The user id including their nickname

`Optional` queue

queue?: ErApiQueue

Methods

`Private` createRateLimitedFunction

createRateLimitedFunction<T, R>(fn): ((...args) => Promise<R>)
Type Parameters
- T extends Fn
- R = Awaited<ReturnType<T>>
Parameters
- fn: T
Returns ((...args) => Promise<R>)
- - (...args): Promise<R>
  - Parameters
    - Rest ...args: Parameters<T>
    Returns Promise<R>
- Defined in packages/er-api/src/api/index.ts:150

Class ErApi

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional fetcherOptions?: KyOptions

Optional queue?: ErApiQueue

Returns ErApi

Properties

fetcher

getFreeCharacters

Type declaration

Parameters

Returns Promise<ErFreeCharactersResponse>

getLeaderboard

Type declaration

Parameters

Returns Promise<ErLeaderboardResponse>

getMatchesByMatchId

Type declaration

Parameters

Returns Promise<ErMatchByUserIdResponse>

getMatchesByUserId

Type declaration

Parameters

Returns Promise<ErMatchByUserIdResponse>

getMetaData

Type declaration

Type Parameters

Parameters

Returns Promise<ErMetaDataResponse<T>>

getMetaTypes

Type declaration

Parameters

Returns Promise<ErMetaTypesResponse>

getRankByUserId

Type declaration

Parameters

Returns Promise<ErRankResponse>

getRecommendedRoutes

Type declaration

Parameters

Returns Promise<ErRecommendedRoutesResponse>

getRoute

Type declaration

Parameters

Returns Promise<ErRouteResponse>

getTranslationPath

Type declaration

Parameters

Returns Promise<ErTranslationResponse>

getUser

Type declaration

Parameters

Returns Promise<ErUserResponse>

getUserByNickname

Type declaration

Parameters

Returns Promise<ErUserIdByNicknameResponse>

Optional queue

Methods

Private createRateLimitedFunction

Type Parameters

Parameters

Returns ((...args) => Promise<R>)

Parameters

Returns Promise<R>

Settings

Member Visibility

Theme

On This Page

`Optional` fetcherOptions?: KyOptions

`Optional` queue?: ErApiQueue

`Optional` queue

`Private` createRateLimitedFunction