node-epicsgg
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Leaderboard

Index

Methods

Methods

getCollectionLeaderboards

  • getCollectionLeaderboards(collectionId: number, page?: number, country?: undefined | string, season?: number | string): Promise<CollectionRanking[]>

  • Get the rankings of a given collection id

    Parameters

    • collectionId: number

      the collection id to query

    • Default value page: number = 1

      the page to get (1 page = 20 users)

    • Optional country: undefined | string

      the country to filter the leaderboard

    • Optional season: number | string

      the season to filter the leaderboard

    Returns Promise<CollectionRanking[]>

    a Promise resolved with the response or rejected in case of error

getLeaderboards

  • getLeaderboards(page?: number, country?: undefined | string, season?: number | string): Promise<UserRanking[]>

  • Get the global rankings of Epics.gg given a category id and game id

    Parameters

    • Default value page: number = 1

      the page to get (1 page = 20 users)

    • Optional country: undefined | string

      the country to filter the leaderboard

    • Optional season: number | string

      the season to filter the leaderboard

    Returns Promise<UserRanking[]>

    a Promise resolved with the response or rejected in case of error

Legend

  • Constructor
  • Method
  • Property

Generated using TypeDoc