common library
Classes
- Bubble
- A Bubble is a Step that consists of running a builder function, and its returned Step, until it receives the prompt to stop. Then it will run the candidate it got on the execution of itself.
- Chain
- A Chain is a Bubble that has a builder, which only will returning Steps until the length of the Chain is reached.
- Conditional
- A Conditional is a simple ConfigureStep that will either return its child or a Skipped Step based on condition.
- ConfigureStep
- A ConfigureStep will build it's configure() function into the smallest parts and executes them.
- FlowContext
- A FlowContext holds the information for the package's user to work with the workflow's information without modifying the workflow while it's running.
- FlowContextController
- Controls and contains the FlowContext for a workflow.
- Loop
- A looped chain of Steps.
- Response
- A Response is a message send by a working unit, to communicate with its user.
- Runnable
- Executes the run function as atomic part of a workflow.
- Skipped
- Step that just return the candidate and does nothing.
- Step
- Blueprint of the atomic representation of a step inside of workflows.
Functions
-
runWorkflow(
Step step, [void onData(Response)?]) → Future< Response> - Runs the Step as workflow and creates a FlowContextController for it.