riot-api-typedef/v4/spectator.d.ts

Create enums to represent constant values in the documentation.

import { AllQueues } from "../constants/queues";
import { Maps } from "../constants/maps";

export namespace SpectatorV4 {
    export interface BannedChampion {
        /**
         * The turn during which the champion was banned
         */
        pickTurn: number;
        /**
         * The ID of the banned champion
         */
        championId: number;
        /**
         * The ID of the team that banned the champion 
         */
        teamId: number;
    }

    export interface FeaturedGameInfo {
        /**
         * The ID of the game
         */
        gameId: number;
        /**
         * The game start time represented in epoch milliseconds
         */
        gameStartTime: number;
        /**
         * The ID of the platform on which the game is being played
         */
        platformId: string;
        /**
         * The game mode (Legal values: CLASSIC, ODIN, ARAM, TUTORIAL, ONEFORALL, ASCENSION, FIRSTBLOOD, KINGPORO)
         */
        gameMode: string;
        /**
         * The ID of the map
         */
        mapId: Maps;
        /**
         * The game type (Legal values: CUSTOM_GAME, MATCHED_GAME, TUTORIAL_GAME)
         */
        gameType: string;
        /**
         * Banned champion information
         */
        bannedChampions: BannedChampion[];
        /**
         * The observer information
         */
        observers: Observer;
        /**
         * The participant information
         */
        participants: Participant[];
        /**
         * The amount of time in seconds that has passed since the game started
         */
        gameLength: number;
        /**
         * The queue type (queue types are documented on the Game Constants page) 
         */
        gameQueueConfigId: AllQueues;
    }

    export interface FeaturedGames {
        /**
         *  The suggested interval to wait before requesting FeaturedGames again 
         */
        clientRefreshInterval: number;
    
        /**
         * The list of featured games 
         */
        gameList: FeaturedGameInfo[];
    }

    export interface Observer {
        /**
         * Key used to decrypt the spectator grid game data for playback 
         */
        encryptionKey: string;
    }

    export interface Participant {
        /**
         * The ID of the profile icon used by this participant 
         */
        profileIconId: number;
    
        /**
         *  The ID of the champion played by this participant 
         */
        champinoId: number;
    
        /**
         * The summoner name of this participant 
         */
        summonerName: string;
    
        /**
         * Flag indicating whether or not this participant is a bot 
         */
        bot: boolean;
    
        /**
         * The ID of the second summoner spell used by this participant 
         */
        spell2Id: number;
    
        /**
         * The team ID of this participant, indicating the participant's team 
         */
        teamId: number;
    
        /**
         * The ID of the first summoner spell used by this participant 
         */
        spell1Id: number;
    }
}