Prometheus Entity Management API
Preparing search index...
@prometheus-ags/prometheus-entity-management
GQLListOptions
Interface GQLListOptions<TData, TEntity>
interface
GQLListOptions
<
TData
,
TEntity
extends
object
>
{
client
:
GQLClient
;
descriptor
:
EntityDescriptor
<
unknown
,
TEntity
>
;
document
:
string
;
enabled
?:
boolean
;
getItems
:
(
data
:
TData
)
=>
unknown
[]
;
getPagination
?:
(
data
:
TData
,
)
=>
{
hasNextPage
?:
boolean
;
nextCursor
?:
string
;
page
?:
number
;
pageSize
?:
number
;
total
?:
number
;
}
;
mode
?:
"replace"
|
"append"
;
queryKey
:
unknown
[]
;
sideDescriptors
?:
EntityDescriptor
<
unknown
,
Record
<
string
,
unknown
>
>
[]
;
staleTime
?:
number
;
type
:
string
;
variables
?:
Record
<
string
,
unknown
>
;
}
Type Parameters
TData
TEntity
extends
object
Index
Properties
client
descriptor
document
enabled?
get
Items
get
Pagination?
mode?
query
Key
side
Descriptors?
stale
Time?
type
variables?
Properties
client
client
:
GQLClient
descriptor
descriptor
:
EntityDescriptor
<
unknown
,
TEntity
>
document
document
:
string
Optional
enabled
enabled
?:
boolean
get
Items
getItems
:
(
data
:
TData
)
=>
unknown
[]
Optional
get
Pagination
getPagination
?:
(
data
:
TData
,
)
=>
{
hasNextPage
?:
boolean
;
nextCursor
?:
string
;
page
?:
number
;
pageSize
?:
number
;
total
?:
number
;
}
Optional
mode
mode
?:
"replace"
|
"append"
query
Key
queryKey
:
unknown
[]
Optional
side
Descriptors
sideDescriptors
?:
EntityDescriptor
<
unknown
,
Record
<
string
,
unknown
>
>
[]
Optional
stale
Time
staleTime
?:
number
type
type
:
string
Optional
variables
variables
?:
Record
<
string
,
unknown
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
client
descriptor
document
enabled
get
Items
get
Pagination
mode
query
Key
side
Descriptors
stale
Time
type
variables
Prometheus Entity Management API
Loading...