Base class for modules that rely on a config value and could apply to input documents (or not) depending
on whether the config delegate requires them.
- Namespace
- Statiq
.Common - Interfaces
- Base Types
-
- object
- Module
- Derived Types
graph BT
Type-->Base0["Module"]
click Base0 "/api/Statiq.Common/Module"
Base0-->Base1["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type["ConfigModule<TValue>"]
class Type type-node
Derived0["CreateDocuments"]-->Type
click Derived0 "/api/Statiq.Core/CreateDocuments"
Derived1["SyncConfigModule<TValue>"]-->Type
click Derived1 "/api/Statiq.Common/SyncConfigModule_1"
Derived2["ExecuteDestinations"]-->Type
click Derived2 "/api/Statiq.Core/ExecuteDestinations"
Derived3["ExecuteSources"]-->Type
click Derived3 "/api/Statiq.Core/ExecuteSources"
Syntax
public abstract class ConfigModule<TValue> : Module, IModuleType Parameters
| Name | Description |
|---|---|
| TValue |
Constructors
| Name | Summary |
|---|---|
| ConfigModule |
Creates a new config module. |
Methods
| Name | Return Value | Summary |
|---|---|---|
| AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
| AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
| BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
|
| ExecuteConfigAsync |
Task |
Executes the module for each input document.
If there aren't any input documents and the config delegate doesn't require documents,
this will be called once with a null input.
|
| 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.
Inherited from Module
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| SetConfig |
ConfigModule |