Documentation
Preparing search index...
rivetkit
inspector/mod
createActorInspectorClient
Function createActorInspectorClient
createActorInspectorClient
(
...
args
:
[
baseUrl
:
string
,
options
?:
ClientRequestOptions
]
,
)
:
{
ping
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{
message
:
string
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
&
{
state
:
ClientRequest
<
{
$get
:
|
{
input
:
{}
;
output
:
{
enabled
:
true
;
state
:
JSONValue
}
;
outputFormat
:
"json"
;
status
:
200
;
}
|
{
input
:
{}
;
output
:
{
enabled
:
false
;
state
:
null
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
&
{
$patch
:
|
{
input
:
{
json
:
{
patch
:
(...)
[]
}
|
{
replace
:
any
}
}
;
output
:
{
enabled
:
false
}
;
outputFormat
:
"json"
;
status
:
200
;
}
|
{
input
:
{
json
:
{
patch
:
(...)
[]
}
|
{
replace
:
any
}
}
;
output
:
{
enabled
:
true
;
state
:
JSONValue
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
&
{
state
:
{
stream
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{}
;
outputFormat
:
string
;
status
:
StatusCode
;
}
;
}
,
>
;
}
;
}
&
{
connections
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{
connections
:
{
auth
?:
{
[
key
:
string
]:
any
}
;
id
:
string
;
params
?:
{
[
key
:
string
]:
any
}
;
state
?:
any
;
stateEnabled
?:
boolean
;
}
[]
;
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
&
{
connections
:
{
stream
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{}
;
outputFormat
:
string
;
status
:
StatusCode
;
}
;
}
,
>
;
}
;
}
&
{
events
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{
events
:
(
|
{
args
:
never
;
connId
:
string
;
id
:
string
;
name
:
string
;
timestamp
:
number
;
type
:
"action"
;
}
|
{
args
:
never
;
eventName
:
string
;
id
:
string
;
timestamp
:
number
;
type
:
"broadcast"
;
}
|
{
connId
:
string
;
eventName
:
string
;
id
:
string
;
timestamp
:
number
;
type
:
"subscribe"
;
}
|
{
connId
:
string
;
eventName
:
string
;
id
:
string
;
timestamp
:
number
;
type
:
"unsubscribe"
;
}
|
{
args
:
never
;
connId
:
string
;
eventName
:
string
;
id
:
string
;
timestamp
:
number
;
type
:
"event"
;
}
)
[]
;
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
&
{
events
:
{
clear
:
ClientRequest
<
{
$post
:
{
input
:
{}
;
output
:
{
message
:
string
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
;
}
&
{
events
:
{
stream
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{}
;
outputFormat
:
string
;
status
:
StatusCode
;
}
;
}
,
>
;
}
;
}
&
{
rpcs
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{
rpcs
:
string
[]
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
&
{
db
:
ClientRequest
<
{
$get
:
|
{
input
:
{}
;
output
:
{
db
:
null
;
enabled
:
false
}
;
outputFormat
:
"json"
;
status
:
200
;
}
|
{
input
:
{}
;
output
:
{
db
:
{
columns
:
(...)
[]
;
foreignKeys
:
(...)
[]
;
records
:
any
;
table
:
{
name
:
...
;
schema
:
...
;
type
:
...
}
;
}
[]
;
enabled
:
true
;
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
&
{
$post
:
|
{
input
:
{
json
:
{
params
?:
(...)
[]
;
query
:
string
}
}
;
output
:
{
enabled
:
false
}
;
outputFormat
:
"json"
;
status
:
200
;
}
|
{
input
:
{
json
:
{
params
?:
(...)
[]
;
query
:
string
}
}
;
output
:
{
result
:
JSONValue
}
;
outputFormat
:
"json"
;
status
:
200
;
}
|
{
input
:
{
json
:
{
params
?:
(...)
[]
;
query
:
string
}
}
;
output
:
{
error
:
string
}
;
outputFormat
:
"json"
;
status
:
500
;
}
;
}
,
>
;
}
&
{
action
:
ClientRequest
<
{
$post
:
{
input
:
{
json
:
{
name
:
string
;
params
?:
any
[]
}
}
;
output
:
{
result
:
JSONValue
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
Parameters
...
args
:
[
baseUrl
:
string
,
options
?:
ClientRequestOptions
]
Returns
{
ping
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{
message
:
string
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
&
{
state
:
ClientRequest
<
{
$get
:
|
{
input
:
{}
;
output
:
{
enabled
:
true
;
state
:
JSONValue
}
;
outputFormat
:
"json"
;
status
:
200
;
}
|
{
input
:
{}
;
output
:
{
enabled
:
false
;
state
:
null
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
&
{
$patch
:
|
{
input
:
{
json
:
{
patch
:
(...)
[]
}
|
{
replace
:
any
}
}
;
output
:
{
enabled
:
false
}
;
outputFormat
:
"json"
;
status
:
200
;
}
|
{
input
:
{
json
:
{
patch
:
(...)
[]
}
|
{
replace
:
any
}
}
;
output
:
{
enabled
:
true
;
state
:
JSONValue
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
&
{
state
:
{
stream
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{}
;
outputFormat
:
string
;
status
:
StatusCode
;
}
;
}
,
>
;
}
;
}
&
{
connections
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{
connections
:
{
auth
?:
{
[
key
:
string
]:
any
}
;
id
:
string
;
params
?:
{
[
key
:
string
]:
any
}
;
state
?:
any
;
stateEnabled
?:
boolean
;
}
[]
;
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
&
{
connections
:
{
stream
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{}
;
outputFormat
:
string
;
status
:
StatusCode
;
}
;
}
,
>
;
}
;
}
&
{
events
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{
events
:
(
|
{
args
:
never
;
connId
:
string
;
id
:
string
;
name
:
string
;
timestamp
:
number
;
type
:
"action"
;
}
|
{
args
:
never
;
eventName
:
string
;
id
:
string
;
timestamp
:
number
;
type
:
"broadcast"
;
}
|
{
connId
:
string
;
eventName
:
string
;
id
:
string
;
timestamp
:
number
;
type
:
"subscribe"
;
}
|
{
connId
:
string
;
eventName
:
string
;
id
:
string
;
timestamp
:
number
;
type
:
"unsubscribe"
;
}
|
{
args
:
never
;
connId
:
string
;
eventName
:
string
;
id
:
string
;
timestamp
:
number
;
type
:
"event"
;
}
)
[]
;
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
&
{
events
:
{
clear
:
ClientRequest
<
{
$post
:
{
input
:
{}
;
output
:
{
message
:
string
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
;
}
&
{
events
:
{
stream
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{}
;
outputFormat
:
string
;
status
:
StatusCode
;
}
;
}
,
>
;
}
;
}
&
{
rpcs
:
ClientRequest
<
{
$get
:
{
input
:
{}
;
output
:
{
rpcs
:
string
[]
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
&
{
db
:
ClientRequest
<
{
$get
:
|
{
input
:
{}
;
output
:
{
db
:
null
;
enabled
:
false
}
;
outputFormat
:
"json"
;
status
:
200
;
}
|
{
input
:
{}
;
output
:
{
db
:
{
columns
:
(...)
[]
;
foreignKeys
:
(...)
[]
;
records
:
any
;
table
:
{
name
:
...
;
schema
:
...
;
type
:
...
}
;
}
[]
;
enabled
:
true
;
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
&
{
$post
:
|
{
input
:
{
json
:
{
params
?:
(...)
[]
;
query
:
string
}
}
;
output
:
{
enabled
:
false
}
;
outputFormat
:
"json"
;
status
:
200
;
}
|
{
input
:
{
json
:
{
params
?:
(...)
[]
;
query
:
string
}
}
;
output
:
{
result
:
JSONValue
}
;
outputFormat
:
"json"
;
status
:
200
;
}
|
{
input
:
{
json
:
{
params
?:
(...)
[]
;
query
:
string
}
}
;
output
:
{
error
:
string
}
;
outputFormat
:
"json"
;
status
:
500
;
}
;
}
,
>
;
}
&
{
action
:
ClientRequest
<
{
$post
:
{
input
:
{
json
:
{
name
:
string
;
params
?:
any
[]
}
}
;
output
:
{
result
:
JSONValue
}
;
outputFormat
:
"json"
;
status
:
200
;
}
;
}
,
>
;
}
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
Documentation
Loading...