Prometheus Entity Management API
Preparing search index...
@prometheus-ags/prometheus-entity-management
GQLEntityOptions
Interface GQLEntityOptions<TData, TEntity>
interface
GQLEntityOptions
<
TData
,
TEntity
extends
object
>
{
client
:
GQLClient
;
descriptor
:
EntityDescriptor
<
unknown
,
TEntity
>
;
document
:
string
;
enabled
?:
boolean
;
id
:
string
|
null
|
undefined
;
onError
?:
(
err
:
Error
)
=>
void
;
onSuccess
?:
(
data
:
TData
)
=>
void
;
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?
id
on
Error?
on
Success?
side
Descriptors?
stale
Time?
type
variables?
Properties
client
client
:
GQLClient
descriptor
descriptor
:
EntityDescriptor
<
unknown
,
TEntity
>
document
document
:
string
Optional
enabled
enabled
?:
boolean
id
id
:
string
|
null
|
undefined
Optional
on
Error
onError
?:
(
err
:
Error
)
=>
void
Optional
on
Success
onSuccess
?:
(
data
:
TData
)
=>
void
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
id
on
Error
on
Success
side
Descriptors
stale
Time
type
variables
Prometheus Entity Management API
Loading...