Overview
Can be accessed using client.helix.games on an ApiClient instance.
Example
const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
const game = await api.helix.games.getGameByName('Hearthstone');
Methods
getGameById(id)
asyncRetrieves the game data for the given game ID.
| Parameter | Type | Description |
|---|---|---|
| id | string | The game ID you want to look up. |
Return type: HelixGame | null
getGameByName(name)
asyncRetrieves the game data for the given game name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The game name you want to look up. |
Return type: HelixGame | null
getGamesByIds(ids)
asyncRetrieves the game data for the given list of game IDs.
| Parameter | Type | Description |
|---|---|---|
| ids | Array<string> | The game IDs you want to look up. |
Return type: Array<HelixGame>
getGamesByNames(names)
asyncRetrieves the game data for the given list of game names.
| Parameter | Type | Description |
|---|---|---|
| names | Array<string> | The game names you want to look up. |
Return type: Array<HelixGame>
getTopGames(pagination)
asyncRetrieves a list of the most viewed games at the moment.
| Parameter | Type | Description |
|---|---|---|
| pagination | HelixPagination | Pagination info. |
Return type: HelixPaginatedResult<HelixGame>
getTopGamesPaginated()
Creates a paginator for the most viewed games at the moment.
Return type: HelixPaginatedRequest<HelixGameData, HelixGame>