useGMFYRatingLeaderboard

import { useGMFYRatingLeaderboard } from 'gmfy-sdk'

Мотивация

Если необходимо отрисовать свой UI или просто обработать данные, можно воспользоваться хуком useGMFYRatingLeaderboard. Хук позволяет получить список лидеров определённого рейтинга. В случае, если был передан updateInterval в конфиг компонента провайдера, будет возвращать новые значения раз в updateInterval мс. Возвращает список лидеров и текущий статус запроса

Типизация

type RatingLeaderboardUnit = {
    userId: string;
    clientId: string;
    ratingId: string;
    name: string;
    value: number;
    metaInfo: Record<string, any>;
    position: number;
}

type Status = 'initial' | | 'done' | 'fail'

useGMFYRatingLeaderboard(): { ratingLeaderboard: <Array<RatingLeaderboardUnit>> | null; status: Status }

RatingLeaderboardUnit

• userId - ID пользователя
• clientId - ID клиента
• ratingId - ID рейтинга
• name - название рейтинга
• value - рейтинг пользователя
• metaInfo - пользовательская информация
• position - позиция пользователя в рейтинге

Status

• initial - начальный статус, запрос ещё не был отправлен
• done - запрос прошёл успешно
• fail - во время выполнения запроса возникла ошибка

Использование

import { useGMFYRatingLeaderboard } from 'gmfy-sdk';

const App = () => {
    const { ratingLeaderboard, status } = useGMFYRatingLeaderboard();

    if (status !== 'done') {
        return <Preloader />;
    }

    return <YourTableComponent data={ratingLeaderboard} />;
};