Namespace

Interfaces

IModule

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["MultiConfigModuleBase"] class Type type-node Derived0["MultiConfigModule"]-->Type click Derived0 "/api/Statiq.Common/MultiConfigModule" Derived1["ParallelMultiConfigModule"]-->Type click Derived1 "/api/Statiq.Common/ParallelMultiConfigModule"

Syntax

[Obsolete("Derive from MultiConfigModule or ParallelMultiConfigModule.")]
public abstract class MultiConfigModuleBase : Module, IModule

Attributes

Type	Description
ObsoleteAttribute

Properties

Name	Property Type	Summary
Configs	IReadOnlyDictionary<string, IConfig>
ForceDocumentExecution	bool

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
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IDocument, IExecutionContext, Task<TValue>>)	MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IDocument, IExecutionContext, TValue>)	MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IExecutionContext, Task<TValue>>)	MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, IExecutionContext, TValue>)	MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, Task<TValue>>)	MultiConfigModuleBase
CombineConfig<TValue>(string, Config<TValue>, Func<TValue, TValue, TValue>)	MultiConfigModuleBase
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, IMetadata)	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. Inherited from 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
GetConfig(string)	IConfig	Gets the config for a given key.
GetConfig<TValue>(string)	Config<TValue>	Gets the config for a given key cast to a specific config value.
SetConfig(string, IConfig)	MultiConfigModuleBase	Sets the config for a given key.
TryGetConfig(string, IConfig)	bool

Extension Methods

Name	Value	Summary
ForEachDocument()	ForEachDocument	From IModuleExtensions
ThrowIfNull<MultiConfigModuleBase>(string)	T	From GuardExtensions
ToDocument<MultiConfigModuleBase>(IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<MultiConfigModuleBase>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<MultiConfigModuleBase>(NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<MultiConfigModuleBase>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<MultiConfigModuleBase>(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<MultiConfigModuleBase>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions