Type Aliases

The following type aliases are available globally.


                    
                    
                    AsyncProcessStepHandler

Handler that allows some custom action to be performed for AsyncProcessStep, with the return value used to drive control flow of the steps.

Swift

public typealias AsyncProcessStepHandler = (_ model: JSON, _ completion: @escaping (JSON, StepFlowResult) -> Void) -> Void


                                model

The model JSON dictionary.

A tuple with the modified model and a StepFlowResult which allows control flow of the steps.

Show on GitHub


                    
                    
                    StepCompletionCallback

Callback that should be invoked when the step’s run method is complete, and can provides instruction on what to do next (e.g. proceed or fail).

Swift

public typealias StepCompletionCallback = (_ result: StepCompletionResult) -> Void


                                result

Result indicating what to do next (i.e. control flow instruction). The JSON model must be provided to pass onto the next step.

Show on GitHub


                    
                    
                    ProcessStepHandler

Handler that allows some custom action to be performed for ProcessStep, with the return value used to drive control flow of the steps.

Swift

public typealias ProcessStepHandler = (_ model: inout JSON) -> StepFlowResult


                                model

The model JSON dictionary which can be modified by the step.

The StepFlowResult which allows control flow of the steps.

Show on GitHub


                    
                    
                    ScriptStepHandler

Callback invoked when a ScriptStep or AsyncScriptStep is finished.

Swift

public typealias ScriptStepHandler = (_ response: Any?, _ model: inout JSON) -> StepFlowResult

`response`	Data returned from JavaScript.
`model`	The model JSON dictionary which can be modified by the step.

The StepFlowResult which allows control flow of the steps.

Show on GitHub