@globalleaderboards/sdk - v0.5.0
    Preparing search index...

    Interface LeaderboardUpdateMessage

    Leaderboard update message with full state and mutations

    interface LeaderboardUpdateMessage {
        type: "leaderboard_update";
        id: string;
        timestamp: string;
        payload: {
            leaderboardId: string;
            updateType: "score_update" | "full_refresh" | "bulk_update";
            leaderboard: {
                entries: LeaderboardEntry[];
                totalEntries: number;
                displayedEntries: number;
            };
            mutations: LeaderboardMutation[];
            trigger: UpdateTrigger;
            sequence: number;
        };
    }

    Hierarchy (View Summary)

    Index

    Properties

    type: "leaderboard_update"
    id: string
    timestamp: string
    payload: {
        leaderboardId: string;
        updateType: "score_update" | "full_refresh" | "bulk_update";
        leaderboard: {
            entries: LeaderboardEntry[];
            totalEntries: number;
            displayedEntries: number;
        };
        mutations: LeaderboardMutation[];
        trigger: UpdateTrigger;
        sequence: number;
    }