@playlive/react-query
    Preparing search index...

    Interface UseLeaderboardExclusionsResult

    Return shape for useLeaderboardExclusions.

    interface UseLeaderboardExclusionsResult {
        addExclusion: (donorName: string) => Promise<LeaderboardExclusion>;
        data: LeaderboardExclusion[] | undefined;
        donorNames: string[];
        error: Error | null;
        isFetching: boolean;
        isLoading: boolean;
        isMutating: boolean;
        isPending: boolean;
        refetch: (options?: HookRefetchOptions) => Promise<void>;
        removeExclusion: (donorName: string) => Promise<LeaderboardExclusion>;
    }
    Index
    addExclusion data donorNames error isFetching isLoading isMutating isPending refetch removeExclusion
    addExclusion: (donorName: string) => Promise<LeaderboardExclusion>

    Add a donor name to the exclusion list. Rejects on non-2xx.

    data: LeaderboardExclusion[] | undefined

    Latest donor-name exclusion list (empty until first success).

    donorNames: string[]

    Flat string[] projection of data — donor names only. Handy for Array.includes(name) checks.

    error: Error | null
    isFetching: boolean
    isLoading: boolean
    isMutating: boolean

    true while a POST or DELETE mutation is in flight.

    isPending: boolean
    refetch: (options?: HookRefetchOptions) => Promise<void>

    Manually refetch.

    removeExclusion: (donorName: string) => Promise<LeaderboardExclusion>

    Remove a donor name from the exclusion list. Rejects on non-2xx.

    Settings
    Member Visibility

    On This Page
    Properties