openfrontio-api-client
    Preparing search index...

    Variable default

    default: {
        getClanLeaderboard: () => Promise<
            {
                clans: {
                    clanTag: string;
                    games: number;
                    losses: number;
                    playerSessions: number;
                    weightedLosses: number;
                    weightedWins: number;
                    weightedWLRatio: number;
                    wins: number;
                }[];
                end: string;
                start: string;
            }[],
        >;
        getClanSessions: (params: GetClanSessionsParams) => Promise<ClanSession[]>;
        getClanStats: (params: GetClanStatsParams) => Promise<ClanStats>;
        getGameInfo: (params: GetGameInfoParams) => Promise<PartialGameRecord>;
        getGames: (params: GameListOptions) => Promise<PaginatedGameList>;
        getPlayerInfo: (
            params: GetPlayerInfoParams,
        ) => Promise<
            {
                createdAt: string;
                games: {
                    clientId?: string;
                    difficulty: Difficulty;
                    gameId: string;
                    map: GameMapType;
                    mode: GameMode;
                    start: string;
                    type: GameType;
                }[];
                stats: Partial<
                    Record<
                        GameType,
                        Partial<
                            Record<
                                GameMode,
                                Partial<
                                    Record<
                                        Difficulty,
                                        { losses: ...; stats?: ...; total: ...; wins: ... },
                                    >,
                                >,
                            >,
                        >,
                    >,
                >;
                user?: {
                    avatar: string | null;
                    discriminator: string;
                    global_name: string | null;
                    id: string;
                    username: string;
                };
            },
        >;
        getPlayerSessions: (
            params: GetPlayerSessionsParams,
        ) => Promise<PlayerSessions>;
    }

    Type Declaration

    • getClanLeaderboard: () => Promise<
          {
              clans: {
                  clanTag: string;
                  games: number;
                  losses: number;
                  playerSessions: number;
                  weightedLosses: number;
                  weightedWins: number;
                  weightedWLRatio: number;
                  wins: number;
              }[];
              end: string;
              start: string;
          }[],
      >
    • getClanSessions: (params: GetClanSessionsParams) => Promise<ClanSession[]>
    • getClanStats: (params: GetClanStatsParams) => Promise<ClanStats>
    • getGameInfo: (params: GetGameInfoParams) => Promise<PartialGameRecord>
    • getGames: (params: GameListOptions) => Promise<PaginatedGameList>
    • getPlayerInfo: (
          params: GetPlayerInfoParams,
      ) => Promise<
          {
              createdAt: string;
              games: {
                  clientId?: string;
                  difficulty: Difficulty;
                  gameId: string;
                  map: GameMapType;
                  mode: GameMode;
                  start: string;
                  type: GameType;
              }[];
              stats: Partial<
                  Record<
                      GameType,
                      Partial<
                          Record<
                              GameMode,
                              Partial<
                                  Record<
                                      Difficulty,
                                      { losses: ...; stats?: ...; total: ...; wins: ... },
                                  >,
                              >,
                          >,
                      >,
                  >,
              >;
              user?: {
                  avatar: string | null;
                  discriminator: string;
                  global_name: string | null;
                  id: string;
                  username: string;
              };
          },
      >
    • getPlayerSessions: (params: GetPlayerSessionsParams) => Promise<PlayerSessions>