Documentation
Preparing search index...
@saltcorn/data
models/workflow
export=
Class export=
Workflow class
Implements
AbstractWorkflow
Index
Constructors
constructor
Properties
__
action?
auto
Save?
modify
Form?
on
Done
on
Step
Save?
on
Step
Success?
preview
URL?
save
URL?
start
At
Step
URL?
steps
Methods
run
run
Step
single
Step
Form
title
Constructors
constructor
new
"export="
(
o
:
WorkflowCfg
)
:
export=
Workflow constructor
Parameters
o
:
WorkflowCfg
Returns
export=
Properties
__
__
:
any
Optional
action
action
?:
string
Optional
auto
Save
autoSave
?:
boolean
Optional
modify
Form
modifyForm
?:
(
form
:
export=
)
=>
void
on
Done
onDone
:
(
context
:
any
)
=>
any
Optional
on
Step
Save
onStepSave
?:
(
step
:
any
,
context
:
any
,
formVals
:
any
)
=>
any
Optional
on
Step
Success
onStepSuccess
?:
(
step
:
any
,
context
:
any
)
=>
any
Optional
preview
URL
previewURL
?:
string
Optional
save
URL
saveURL
?:
string
Optional
start
At
Step
URL
startAtStepURL
?:
(
stepName
:
string
)
=>
string
steps
steps
:
any
[]
Methods
run
run
(
body
?:
any
,
req
?:
any
)
:
Promise
<
undefined
|
RunResult
>
Parameters
Optional
body
:
any
Optional
req
:
any
Returns
Promise
<
undefined
|
RunResult
>
run
Step
runStep
(
context
:
any
,
stepIx
:
number
)
:
Promise
<
undefined
|
RunResult
>
Parameters
context
:
any
stepIx
:
number
Returns
Promise
<
undefined
|
RunResult
>
single
Step
Form
singleStepForm
(
body
?:
any
,
req
?:
any
)
:
Promise
<
undefined
|
RunResult
>
Parameters
Optional
body
:
any
Optional
req
:
any
Returns
Promise
<
undefined
|
RunResult
>
title
title
(
step
:
any
,
stepIx
:
number
)
:
string
Parameters
step
:
any
stepIx
:
number
Returns
string
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
__
action
auto
Save
modify
Form
on
Done
on
Step
Save
on
Step
Success
preview
URL
save
URL
start
At
Step
URL
steps
Methods
run
run
Step
single
Step
Form
title
Documentation
Loading...
Workflow class