@playlive/react-query
Preparing search index...
UseTiltifyLeaderboardResult
Interface UseTiltifyLeaderboardResult
Return shape for
useTiltifyLeaderboard
.
interface
UseTiltifyLeaderboardResult
{
data
:
|
{
pageParams
:
(
string
|
number
|
null
|
undefined
)
[]
;
pages
:
PaginatedResponse
<
TiltifyLeaderboardEntry
,
TiltifyPaginationMetadata
,
>
[]
;
}
|
undefined
;
entries
:
TiltifyLeaderboardEntry
[]
;
error
:
Error
|
null
;
fetchNextPage
:
()
=>
Promise
<
void
>
;
hasNextPage
:
boolean
;
isFetching
:
boolean
;
isFetchingNextPage
:
boolean
;
isLoading
:
boolean
;
isPending
:
boolean
;
refetch
:
(
options
?:
HookRefetchOptions
)
=>
Promise
<
void
>
;
}
Index
Properties
data
entries
error
fetch
Next
Page
has
Next
Page
is
Fetching
is
Fetching
Next
Page
is
Loading
is
Pending
refetch
Properties
data
data
:
|
{
pageParams
:
(
string
|
number
|
null
|
undefined
)
[]
;
pages
:
PaginatedResponse
<
TiltifyLeaderboardEntry
,
TiltifyPaginationMetadata
,
>
[]
;
}
|
undefined
entries
entries
:
TiltifyLeaderboardEntry
[]
Flat entries across every fetched page.
error
error
:
Error
|
null
fetch
Next
Page
fetchNextPage
:
()
=>
Promise
<
void
>
has
Next
Page
hasNextPage
:
boolean
is
Fetching
isFetching
:
boolean
is
Fetching
Next
Page
isFetchingNextPage
:
boolean
is
Loading
isLoading
:
boolean
is
Pending
isPending
:
boolean
refetch
refetch
:
(
options
?:
HookRefetchOptions
)
=>
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
data
entries
error
fetch
Next
Page
has
Next
Page
is
Fetching
is
Fetching
Next
Page
is
Loading
is
Pending
refetch
@playlive/react-query
Loading...
Return shape for useTiltifyLeaderboard.