◆ add()
| PipelineBuilder::add | ( | flowElement | ) |
inline
Add a single flowElement to be executed in series.
- Parameters
-
- {FlowElement} - flowElement flowElement to add to the Pipeline
- Returns
- {PipelineBuilder} Pipeline builder for easy chaining
- Examples
- pipelines.js.
◆ addParallel()
PipelineBuilder::addParallel ( flowElements ) inlineAdd an array of flowElements to be executed in parallel.
- Parameters
-
- {FlowElement[]} - flowElements array of FlowElements to add to the Pipeline (to be exeuted in parallel)
- Returns
- {PipelineBuilder} Pipeline builder for easy chaining
- Examples
- pipelines.js.
◆ addRequiredElements()
PipelineBuilder::addRequiredElements ( flowElements ) inlineAdd required elements to an existing FlowElement array.
- Parameters
-
- {FlowElement[]} - flowElements array of elements to add to
- Returns
- {FlowElement[]} resulting array with required elements
◆ build()
◆ buildFromConfiguration()
PipelineBuilder::buildFromConfiguration ( config ) inlineCreate a pipeline from a JSON configuration.
- Parameters
-
- {object} - config a JSON configuration object
- Returns
- {Pipeline} the constructed pipeline
◆ buildFromConfigurationFile()
PipelineBuilder::buildFromConfigurationFile ( configPath ) inlineHelper that loads a JSON configuration file from the filesystem and calls pipelineBuilder.buildFromConfiguration.
- Parameters
-
- {string} - configPath path to a JSON configuration file
- Returns
- {Pipeline} the constructed pipeline
◆ constructor()
PipelineBuilder::constructor ( settings = {}) inlineConstructor for pipeline builder.
- Parameters
-
- {object} - settings settings for the pipeline being constructed
- {boolean} - settings.addJavaScriptBuilder Whether to automatically add the JSONBundler, JavaScriptBuilder and Sequence elements needed to output JavaScript from the system and generate an endpoint for fetching the properties generated by a pipeline from the client side. This is true by default.
- {boolean} - settings.useSetHeaderProperties Whether to automatically add the SetHeadersElement needed to request additional HTTP headers from the client side. This is true by default.
- {typeof - import('./javascriptbuilder').prototype.settings} settings.javascriptBuilderSettings The settings to pass to the JavaScriptBuilder. See JavaScriptBuilder class for details.
@type {FlowElement[]}
◆ getHttpElements()
PipelineBuilder::getHttpElements ( ) inlineInternal function used to first check if the HTTP elements should be added to the pipeline and add them if requested.
- Returns
- {FlowElement[]} list of HTTP related FlowElements
◆ getJavaScriptElements()
PipelineBuilder::getJavaScriptElements ( ) inlineInternal function used to first check if the JavaScript elements should be added to the pipeline and add them if requested.
- Returns
- {FlowElement[]} list of JavaScript related FlowElements