@logixjs/sandbox
Preparing search index...
SandboxClient
Class SandboxClient
Index
Constructors
constructor
Methods
compile
get
State
init
list
Kernels
run
subscribe
terminate
trial
Run
Module
ui
Callback
Constructors
constructor
new
SandboxClient
(
config
?:
SandboxClientConfig
)
:
SandboxClient
Parameters
config
:
SandboxClientConfig
= {}
Returns
SandboxClient
Methods
compile
compile
(
code
:
string
,
filename
?:
string
,
mockManifest
?:
MockManifest
,
options
?:
KernelRunOptions
,
)
:
Promise
<
{
bundle
?:
string
;
errors
?:
string
[]
;
success
:
boolean
}
>
Parameters
code
:
string
Optional
filename
:
string
Optional
mockManifest
:
MockManifest
Optional
options
:
KernelRunOptions
Returns
Promise
<
{
bundle
?:
string
;
errors
?:
string
[]
;
success
:
boolean
}
>
get
State
getState
()
:
SandboxClientState
Returns
SandboxClientState
init
init
()
:
Promise
<
void
>
Returns
Promise
<
void
>
list
Kernels
listKernels
()
:
{
defaultKernelId
?:
string
;
kernels
:
readonly
KernelVariant
[]
}
Returns
{
defaultKernelId
?:
string
;
kernels
:
readonly
KernelVariant
[]
}
run
run
(
options
?:
{
actions
?:
readonly
{
_tag
:
string
;
payload
?:
unknown
}
[]
;
allowFallback
?:
boolean
;
kernelId
?:
string
;
runId
?:
string
;
strict
?:
boolean
;
useCompiledCode
?:
boolean
;
}
,
)
:
Promise
<
RunResult
>
Parameters
Optional
options
:
{
actions
?:
readonly
{
_tag
:
string
;
payload
?:
unknown
}
[]
;
allowFallback
?:
boolean
;
kernelId
?:
string
;
runId
?:
string
;
strict
?:
boolean
;
useCompiledCode
?:
boolean
;
}
Returns
Promise
<
RunResult
>
subscribe
subscribe
(
listener
:
StateListener
)
:
()
=>
void
Parameters
listener
:
StateListener
Returns
()
=>
void
terminate
terminate
()
:
void
Returns
void
trial
Run
Module
trialRunModule
(
options
:
{
allowFallback
?:
boolean
;
buildEnvConfig
?:
Record
<
string
,
string
|
number
|
boolean
>
;
closeScopeTimeout
?:
number
;
diagnosticsLevel
?:
DiagnosticsLevel
;
filename
?:
string
;
kernelId
?:
string
;
maxEvents
?:
number
;
mockManifest
?:
MockManifest
;
moduleCode
:
string
;
moduleExport
?:
string
;
reportMaxBytes
?:
number
;
runId
?:
string
;
strict
?:
boolean
;
trialRunTimeoutMs
?:
number
;
}
,
)
:
Promise
<
RunResult
>
Parameters
options
:
{
allowFallback
?:
boolean
;
buildEnvConfig
?:
Record
<
string
,
string
|
number
|
boolean
>
;
closeScopeTimeout
?:
number
;
diagnosticsLevel
?:
DiagnosticsLevel
;
filename
?:
string
;
kernelId
?:
string
;
maxEvents
?:
number
;
mockManifest
?:
MockManifest
;
moduleCode
:
string
;
moduleExport
?:
string
;
reportMaxBytes
?:
number
;
runId
?:
string
;
strict
?:
boolean
;
trialRunTimeoutMs
?:
number
;
}
Returns
Promise
<
RunResult
>
ui
Callback
uiCallback
(
payload
:
{
callback
:
string
;
data
?:
unknown
;
intentId
:
string
;
runId
:
string
;
}
,
)
:
Promise
<
void
>
Parameters
payload
:
{
callback
:
string
;
data
?:
unknown
;
intentId
:
string
;
runId
:
string
}
Returns
Promise
<
void
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
compile
get
State
init
list
Kernels
run
subscribe
terminate
trial
Run
Module
ui
Callback
@logixjs/sandbox
Loading...