Prometheus Entity Management API
Preparing search index...
@prometheus-ags/entity-graph-tauri
GraphCommands
Interface GraphCommands
Typed command facade bound to a specific
invoke
function.
interface
GraphCommands
{
clearGraph
()
:
Promise
<
void
>
;
getEntity
(
entityType
:
string
,
entityId
:
string
,
)
:
Promise
<
Record
<
string
,
unknown
>
|
null
>
;
getList
(
queryKey
:
string
,
)
:
Promise
<
{
ids
:
string
[]
;
total
:
number
|
null
}
|
null
>
;
patchEntity
(
payload
:
PatchEntityPayload
)
:
Promise
<
void
>
;
persistSnapshot
(
payload
?:
PersistSnapshotPayload
)
:
Promise
<
void
>
;
platformPing
()
:
Promise
<
PlatformPing
>
;
removeEntity
(
payload
:
RemoveEntityPayload
)
:
Promise
<
void
>
;
restoreSnapshot
(
payload
?:
RestoreSnapshotPayload
)
:
Promise
<
void
>
;
setList
(
payload
:
SetListPayload
)
:
Promise
<
void
>
;
upsertEntity
(
payload
:
UpsertEntityPayload
)
:
Promise
<
void
>
;
}
Index
Methods
clear
Graph
get
Entity
get
List
patch
Entity
persist
Snapshot
platform
Ping
remove
Entity
restore
Snapshot
set
List
upsert
Entity
Methods
clear
Graph
clearGraph
()
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Entity
getEntity
(
entityType
:
string
,
entityId
:
string
,
)
:
Promise
<
Record
<
string
,
unknown
>
|
null
>
Parameters
entityType
:
string
entityId
:
string
Returns
Promise
<
Record
<
string
,
unknown
>
|
null
>
get
List
getList
(
queryKey
:
string
,
)
:
Promise
<
{
ids
:
string
[]
;
total
:
number
|
null
}
|
null
>
Parameters
queryKey
:
string
Returns
Promise
<
{
ids
:
string
[]
;
total
:
number
|
null
}
|
null
>
patch
Entity
patchEntity
(
payload
:
PatchEntityPayload
)
:
Promise
<
void
>
Parameters
payload
:
PatchEntityPayload
Returns
Promise
<
void
>
persist
Snapshot
persistSnapshot
(
payload
?:
PersistSnapshotPayload
)
:
Promise
<
void
>
Parameters
Optional
payload
:
PersistSnapshotPayload
Returns
Promise
<
void
>
platform
Ping
platformPing
()
:
Promise
<
PlatformPing
>
Returns
Promise
<
PlatformPing
>
remove
Entity
removeEntity
(
payload
:
RemoveEntityPayload
)
:
Promise
<
void
>
Parameters
payload
:
RemoveEntityPayload
Returns
Promise
<
void
>
restore
Snapshot
restoreSnapshot
(
payload
?:
RestoreSnapshotPayload
)
:
Promise
<
void
>
Parameters
Optional
payload
:
RestoreSnapshotPayload
Returns
Promise
<
void
>
set
List
setList
(
payload
:
SetListPayload
)
:
Promise
<
void
>
Parameters
payload
:
SetListPayload
Returns
Promise
<
void
>
upsert
Entity
upsertEntity
(
payload
:
UpsertEntityPayload
)
:
Promise
<
void
>
Parameters
payload
:
UpsertEntityPayload
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
clear
Graph
get
Entity
get
List
patch
Entity
persist
Snapshot
platform
Ping
remove
Entity
restore
Snapshot
set
List
upsert
Entity
Prometheus Entity Management API
Loading...
Typed command facade bound to a specific
invokefunction.