A common base class for modules.
- Namespace
- Statiq
.Common - Interfaces
- Base Types
-
- object
- Derived Types
-
- CompileLess
- SyncModule
- RenderRazor
- ReadXmp
- ExecuteIf
- ExecutionPipeline
- FilterDocuments
- CombineDocuments
- CountModule
- ConfigModule
<TValue> - ParallelSyncModule
- ExecuteSwitch
- MirrorResources
- ResolveXrefs
- ParentModule
- Multi
Config Module Base - WriteFiles
- OrderDocuments
- HighlightCode
- GenerateSitemap
- GenerateFeeds
- AddIndexes
- ParallelModule
- JoinDocuments
- GroupDocuments
- ParallelConfigModule
<TValue> - ClearDocuments
- ExecuteBranch
- ReadWeb
- ValidateMetadata
<T> - GenerateRedirects
- GenerateLunrIndex
- AnalyzeCSharp
- Generate
Cloud Search Data - CreateTree
Syntax
public abstract class Module : IModuleRemarks
Documents can either be processed one at a time by overriding
ExecuteInputAsync(IDocument, IExecutionContext) or all
at once by overriding ExecuteContextAsync(IExecutionContext).
Methods
| Name | Return Value | Summary |
|---|---|---|
| AfterExecution |
void |
Called after each module execution.
|
| AfterExecutionAsync |
Task |
Called after each module execution.
|
| BeforeExecution |
void |
Called before each module execution.
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
|
| ExecuteInputAsync |
Task |
Executes the module.
|
| Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
|