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
- ConfigModule
<TValue>
- Derived Types
graph BT
Type-->Base0["ConfigModule<TValue>"]
Base0-->Base1["Module"]
click Base1 "/api/Statiq.Common/Module"
Base1-->Base2["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type["SyncConfigModule<TValue>"]
class Type type-node
Derived0["ThrowException"]-->Type
click Derived0 "/api/Statiq.Core/ThrowException"
Derived1["FilterDestinations"]-->Type
click Derived1 "/api/Statiq.Core/FilterDestinations"
Derived2["LogMessage"]-->Type
click Derived2 "/api/Statiq.Core/LogMessage"
Derived3["ZipDirectory"]-->Type
click Derived3 "/api/Statiq.Core/ZipDirectory"
Derived4["FilterSources"]-->Type
click Derived4 "/api/Statiq.Core/FilterSources"
Syntax
public abstract class SyncConfigModule<TValue> : ConfigModule<TValue>, IModuleType Parameters
| Name | Description |
|---|---|
| TValue |
Constructors
| Name | Summary |
|---|---|
| SyncConfigModule |
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
|
| ExecuteConfig |
IEnumerable |
Executes the module for each input document in parallel.
If there aren't any input documents and the config delegate doesn't require documents,
this will be called once with a null input.
|
| 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.
|
| 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
|