SyncModule Class
A common base class for synchronous modules.
graph BT Type-->Base0["Module"] click Base0 "/api/Statiq.Common/Module" Base0-->Base1["object"] Type-.->Interface0["IModule"] click Interface0 "/api/Statiq.Common/IModule" Type["SyncModule"] class Type type-node Derived0["PaginateDocuments"]-->Type click Derived0 "/api/Statiq.Core/PaginateDocuments" Derived1["FlattenTree"]-->Type click Derived1 "/api/Statiq.Core/FlattenTree" Derived2["SyncParentModule"]-->Type click Derived2 "/api/Statiq.Common/SyncParentModule" Derived3["ReadDataModule<TModule, TItem>"]-->Type click Derived3 "/api/Statiq.Common/ReadDataModule_2" Derived4["RemoveTreePlaceholders"]-->Type click Derived4 "/api/Statiq.Core/RemoveTreePlaceholders" Derived5["TakeDocuments"]-->Type click Derived5 "/api/Statiq.Core/TakeDocuments" Derived6["ReadApplicationInput"]-->Type click Derived6 "/api/Statiq.Core/ReadApplicationInput" Derived7["GatherDocuments"]-->Type click Derived7 "/api/Statiq.Testing/GatherDocuments" Derived8["ApplyDirectoryMetadata"]-->Type click Derived8 "/api/Statiq.Web.Modules/ApplyDirectoryMetadata"

Syntax

public abstract class SyncModule : Module, IModule

Remarks

Documents can either be processed one at a time by overriding ExecuteInput(IDocument, IExecutionContext) or all at once by overriding ExecuteContext(IExecutionContext).

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
ExecuteContext(IExecutionContext) IEnumerable<IDocument>
Executes the module once for all input documents.
ExecuteContextAsync(IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module once for all input documents.
ExecuteInput(IDocument, IExecutionContext) IEnumerable<IDocument>
Executes the module.
ExecuteInputAsync(IDocument, IExecutionContext) Task<IEnumerable<IDocument>>
Executes the 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