ParallelModule Class
A module that processes documents in parallel (with the option to process sequentially).
graph BT Type-->Base0["Module"] click Base0 "/api/Statiq.Common/Module" Base0-->Base1["object"] Type-.->Interface0["IModule"] click Interface0 "/api/Statiq.Common/IModule" Type-.->Interface1["IParallelModule"] click Interface1 "/api/Statiq.Common/IParallelModule" Type["ParallelModule"] class Type type-node Derived0["RenderScriban"]-->Type click Derived0 "/api/Statiq.Scriban/RenderScriban" Derived1["CopyMetadata"]-->Type click Derived1 "/api/Statiq.Core/CopyMetadata" Derived2["GenerateExcerpt"]-->Type click Derived2 "/api/Statiq.Core/GenerateExcerpt" Derived3["ReadApi<TClient>"]-->Type click Derived3 "/api/Statiq.Core/ReadApi_1" Derived4["RenderHandlebars"]-->Type click Derived4 "/api/Statiq.Handlebars/RenderHandlebars" Derived5["ProcessHtml"]-->Type click Derived5 "/api/Statiq.Core/ProcessHtml" Derived6["ProcessShortcodes"]-->Type click Derived6 "/api/Statiq.Core/ProcessShortcodes" Derived7["MakeLinksRootRelative"]-->Type click Derived7 "/api/Statiq.Core/MakeLinksRootRelative" Derived8["TransformXslt"]-->Type click Derived8 "/api/Statiq.Core/TransformXslt" Derived9["ParseJson"]-->Type click Derived9 "/api/Statiq.Core/ParseJson" Derived10["EscapeHtml"]-->Type click Derived10 "/api/Statiq.Core/EscapeHtml" Derived11["AddTitle"]-->Type click Derived11 "/api/Statiq.Core/AddTitle" Derived12["AddRtlSupport"]-->Type click Derived12 "/api/Statiq.Core/AddRtlSupport" Derived13["InsertHtml"]-->Type click Derived13 "/api/Statiq.Core/InsertHtml" Derived14["InsertLinks"]-->Type click Derived14 "/api/Statiq.Core/InsertLinks" Derived15["QueryHtml"]-->Type click Derived15 "/api/Statiq.Core/QueryHtml" Derived16["EvaluateScript"]-->Type click Derived16 "/api/Statiq.Core/EvaluateScript" Derived17["RenderMarkdown"]-->Type click Derived17 "/api/Statiq.Markdown/RenderMarkdown" Derived18["MakeLinksAbsolute"]-->Type click Derived18 "/api/Statiq.Core/MakeLinksAbsolute" Derived19["CompileSass"]-->Type click Derived19 "/api/Statiq.Sass/CompileSass"

Syntax

public abstract class ParallelModule : Module, IModule, IParallelModule

Properties

Name Property Type Summary
Parallel bool
Indicates whether documents will be processed by this module in parallel.

Methods

Name Return Value Summary
AfterExecution(IExecutionContext, ExecutionOutputs) void
Called after each module execution.
Inherited from Module
AfterExecutionAsync(IExecutionContext, ExecutionOutputs) Task
Called after each module execution.
Inherited from Module
BeforeExecution(IExecutionContext) void
Called before each module execution.
Inherited from Module
BeforeExecutionAsync(IExecutionContext) Task
Called before each module execution.
Inherited from Module
ExecuteAsync(IExecutionContext) Task<IEnumerable<IDocument>>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
ExecuteContextAsync(IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module once for all input documents.
ExecuteInputAsync(IDocument, IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module.
Inherited from Module
Finally(IExecutionContext) void
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
FinallyAsync(IExecutionContext) Task
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module

Extension Methods