ConfigModule<TValue> Class
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.
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["ExecuteDestinations"]-->Type click Derived0 "/api/Statiq.Core/ExecuteDestinations" Derived1["CreateDocuments"]-->Type click Derived1 "/api/Statiq.Core/CreateDocuments" Derived2["ExecuteSources"]-->Type click Derived2 "/api/Statiq.Core/ExecuteSources" Derived3["SyncConfigModule<TValue>"]-->Type click Derived3 "/api/Statiq.Common/SyncConfigModule_1"

Syntax

public abstract class ConfigModule<TValue> : Module, IModule

Type Parameters

Name Description
TValue

Constructors

Name Summary
ConfigModule(Config<TValue>, bool) Creates a new config module.

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
ExecuteConfigAsync(IDocument, IExecutionContext, TValue) Task<IEnumerable<IDocument>>
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(IExecutionContext) Task<IEnumerable<IDocument>>
Executes the module once for all input documents.
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
SetConfig(Config<TValue>) ConfigModule<TValue>

Extension Methods