@poprank/sdk/lib/types/rounds.d.ts

PopRank API client and types

export declare type RoundDir = 'left' | 'right';
export declare type RoundPlatform = 'web' | 'discord';
/** Represents a head-to-head round played by one or more users */
export interface RoundConventional {
    readonly kind: 'conventional';
    readonly winnerId: string;
    readonly winnerDbId: string;
    readonly winnerCollection: string;
    readonly loserId: string;
    readonly loserDbId: string;
    readonly loserCollection: string;
    readonly draw?: boolean;
    readonly timestamp: Date;
    /** If played by a single user, the player's identification */
    readonly player?: string;
    readonly dir?: RoundDir;
    readonly platform: RoundPlatform;
}
/**
 * Round with additional name/image URL for the contestants
 * for when the rounds want to be shown visually
 */
export interface RoundWithUrls extends RoundConventional {
    readonly winnerUrl: string;
    readonly winnerName: string;
    readonly loserUrl: string;
    readonly loserName: string;
}