agentOS API Reference - v0.0.1
Docs
Preparing search index...
createAgentOS
Function createAgentOS
createAgentOS
<
TState
=
undefined
,
TConnParams
=
undefined
,
TConnState
=
undefined
,
TVars
=
undefined
,
TInput
=
undefined
,
TEvents
extends
EventSchemaConfig
=
Record
<
never
,
never
>
,
TQueues
extends
QueueSchemaConfig
=
Record
<
never
,
never
>
,
TUserActions
extends
Actions
<
TState
,
TConnParams
,
TConnState
,
TVars
,
TInput
,
DatabaseProvider
<
RawAccess
>
,
TEvents
,
TQueues
,
>
=
Record
<
never
,
never
>
,
>
(
config
?:
AgentOSActorConfigInput
<
TState
,
TConnParams
,
TConnState
,
TVars
,
TInput
,
TEvents
,
TQueues
,
TUserActions
,
>
,
)
:
ActorDefinition
<
TState
,
TConnParams
,
TConnState
,
TVars
,
TInput
,
DatabaseProvider
<
RawAccess
>
,
TEvents
&
BuiltInEvents
,
TQueues
,
TUserActions
&
{
allProcesses
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
cancelCronJob
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
cancelPrompt
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
closeProcessStdin
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
closeShell
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
createPreviewUrl
:
(
c
:
ActorContext
,
port
:
number
,
ttlSeconds
?:
number
,
)
=>
Promise
<
{
expiresAt
:
number
;
path
:
string
;
port
:
number
;
token
:
any
}
,
>
;
deleteSession
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
exec
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
execArgv
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
exists
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
expirePreviewUrl
:
(
c
:
ActorContext
,
token
:
string
)
=>
Promise
<
void
>
;
exportRootFilesystem
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
,
)
=>
Promise
<
any
>
;
getProcess
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
getSession
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
getSessionAgentInfo
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
getSessionCapabilities
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
,
)
=>
Promise
<
any
>
;
getSessionConfig
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
httpRequest
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
killProcess
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
linkSoftware
:
(
c
:
ActorContext
,
descriptor
:
PackageDescriptor
,
)
=>
Promise
<
void
>
;
listAgents
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
listCronJobs
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
listMounts
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
listProcesses
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
listSessions
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
listSoftware
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
mkdir
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
mountFs
:
(
c
:
ActorContext
,
descriptor
:
DynamicMountDescriptor
,
)
=>
Promise
<
void
>
;
move
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
openSession
:
(
c
:
ActorContext
,
input
:
OpenSessionInput
)
=>
Promise
<
void
>
;
openShell
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
processTree
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
prompt
:
(
c
:
ActorContext
,
input
:
PromptInput
)
=>
Promise
<
any
>
;
readdir
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
readdirEntries
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
readdirRecursive
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
readFile
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
readFiles
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
readHistory
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
remove
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
resizeShell
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
respondPermission
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
scheduleCron
:
(
c
:
ActorContext
,
cronOptions
:
SerializableCronJobOptions
,
)
=>
Promise
<
{
id
:
any
}
>
;
setSessionConfigOption
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
,
)
=>
Promise
<
any
>
;
spawn
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
stat
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
stopProcess
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
unloadSession
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
unmountFs
:
(
c
:
ActorContext
,
path
:
string
)
=>
Promise
<
void
>
;
waitProcess
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
waitShell
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
writeFile
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
writeFiles
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
writeProcessStdin
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
writeShell
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
}
,
>
Type Parameters
TState
=
undefined
TConnParams
=
undefined
TConnState
=
undefined
TVars
=
undefined
TInput
=
undefined
TEvents
extends
EventSchemaConfig
=
Record
<
never
,
never
>
TQueues
extends
QueueSchemaConfig
=
Record
<
never
,
never
>
TUserActions
extends
Actions
<
TState
,
TConnParams
,
TConnState
,
TVars
,
TInput
,
DatabaseProvider
<
RawAccess
>
,
TEvents
,
TQueues
,
>
=
Record
<
never
,
never
>
Parameters
config
:
AgentOSActorConfigInput
<
TState
,
TConnParams
,
TConnState
,
TVars
,
TInput
,
TEvents
,
TQueues
,
TUserActions
,
>
= ...
Returns
ActorDefinition
<
TState
,
TConnParams
,
TConnState
,
TVars
,
TInput
,
DatabaseProvider
<
RawAccess
>
,
TEvents
&
BuiltInEvents
,
TQueues
,
TUserActions
&
{
allProcesses
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
cancelCronJob
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
cancelPrompt
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
closeProcessStdin
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
closeShell
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
createPreviewUrl
:
(
c
:
ActorContext
,
port
:
number
,
ttlSeconds
?:
number
,
)
=>
Promise
<
{
expiresAt
:
number
;
path
:
string
;
port
:
number
;
token
:
any
}
,
>
;
deleteSession
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
exec
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
execArgv
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
exists
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
expirePreviewUrl
:
(
c
:
ActorContext
,
token
:
string
)
=>
Promise
<
void
>
;
exportRootFilesystem
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
,
)
=>
Promise
<
any
>
;
getProcess
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
getSession
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
getSessionAgentInfo
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
getSessionCapabilities
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
,
)
=>
Promise
<
any
>
;
getSessionConfig
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
httpRequest
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
killProcess
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
linkSoftware
:
(
c
:
ActorContext
,
descriptor
:
PackageDescriptor
,
)
=>
Promise
<
void
>
;
listAgents
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
listCronJobs
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
listMounts
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
listProcesses
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
listSessions
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
listSoftware
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
mkdir
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
mountFs
:
(
c
:
ActorContext
,
descriptor
:
DynamicMountDescriptor
,
)
=>
Promise
<
void
>
;
move
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
openSession
:
(
c
:
ActorContext
,
input
:
OpenSessionInput
)
=>
Promise
<
void
>
;
openShell
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
processTree
:
(
c
:
ActorContext
)
=>
Promise
<
any
>
;
prompt
:
(
c
:
ActorContext
,
input
:
PromptInput
)
=>
Promise
<
any
>
;
readdir
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
readdirEntries
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
readdirRecursive
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
readFile
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
readFiles
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
readHistory
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
remove
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
resizeShell
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
respondPermission
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
scheduleCron
:
(
c
:
ActorContext
,
cronOptions
:
SerializableCronJobOptions
,
)
=>
Promise
<
{
id
:
any
}
>
;
setSessionConfigOption
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
,
)
=>
Promise
<
any
>
;
spawn
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
stat
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
stopProcess
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
unloadSession
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
unmountFs
:
(
c
:
ActorContext
,
path
:
string
)
=>
Promise
<
void
>
;
waitProcess
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
waitShell
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
writeFile
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
writeFiles
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
writeProcessStdin
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
writeShell
:
(
c
:
ActorContext
,
...
args
:
unknown
[]
)
=>
Promise
<
any
>
;
}
,
>
Settings
Member Visibility
Inherited
Theme
OS
Light
Dark
Docs
agentOS API Reference - v0.0.1
Loading...