An abstract base for modules that execute children and then combine the results with the input documents in some way.

Namespace

Interfaces

IModule
IEnumerable<IModule>
IEnumerable

Base Types

Derived Types

graph BT Type-->Base0["ParentModule"] click Base0 "/api/Statiq.Common/ParentModule" Base0-->Base1["Module"] click Base1 "/api/Statiq.Common/Module" Base1-->Base2["object"] Type-.->Interface0["IModule"] click Interface0 "/api/Statiq.Common/IModule" Type-.->Interface1["IEnumerable<IModule>"] Type-.->Interface2["IEnumerable"] Type["ChildDocumentsModule"] class Type type-node Derived0["AddContentToMetadata"]-->Type click Derived0 "/api/Statiq.Core/AddContentToMetadata" Derived1["SyncChildDocumentsModule"]-->Type click Derived1 "/api/Statiq.Common/SyncChildDocumentsModule"

Syntax

public abstract class ChildDocumentsModule : ParentModule, IModule, IEnumerable<IModule>, 
    IEnumerable

Remarks

The child modules are executed once and the original input documents are passed to the child modules. Wrap the child modules with a ForEachDocument module to execute the child modules for each input document individually. Add a ClearDocuments module as the first child if the original input documents should not be passed to the child modules.

Constructors

Name	Summary
ChildDocumentsModule(IModule[])	Executes the specified modules to get result documents.

Properties

Name	Property Type	Summary
Children	ModuleList	The children of this module. Inherited from ParentModule

Methods

Name	Return Value	Summary
Add(IModule[])	void	Adds modules as a child of this module. Inherited from ParentModule
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
ExecuteChildrenAsync(IExecutionContext, ImmutableArray<IDocument>)	Task<IEnumerable<IDocument>>	Gets the output documents given the input documents and the output documents from the execution of child modules.
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
GetEnumerator()	IEnumerator<IModule>	Inherited from ParentModule

Extension Methods

Name	Value	Summary
Concat<IModule>(IModule)	IEnumerable<T>	From IEnumerableExtensions
ForEachDocument()	ForEachDocument	From IModuleExtensions
GetNext<IModule>(IModule, IEqualityComparer<IModule>)	T	From IEnumerableExtensions
GetNext<IModule>(IModule)	T	From IEnumerableExtensions
GetPrevious<IModule>(IModule, IEqualityComparer<IModule>)	T	From IEnumerableExtensions
GetPrevious<IModule>(IModule)	T	From IEnumerableExtensions
GroupByMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, TElement>, IEqualityComparer<TKey>)	IEnumerable<IGrouping<TKey, TElement>>	Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys. The keys are compared by using a comparer and each group's elements are projected by using a specified function. From GroupByExtensions
GroupByMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, TElement>)	IEnumerable<IGrouping<TKey, TElement>>	Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys and projects the elements for each group by using a specified function. From GroupByExtensions
GroupByMany<IModule, TKey>(Func<IModule, IEnumerable<TKey>>, IEqualityComparer<TKey>)	IEnumerable<IGrouping<TKey, TSource>>	Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys and compares the keys by using a specified comparer. From GroupByExtensions
GroupByMany<IModule, TKey>(Func<IModule, IEnumerable<TKey>>)	IEnumerable<IGrouping<TKey, TSource>>	Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys. From GroupByExtensions
GroupByManyToMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, IEnumerable<TElement>>, IEqualityComparer<TKey>)	IEnumerable<IGrouping<TKey, TElement>>	Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys. The keys are compared by using a comparer and each group's elements are projected by using a specified function that returns a sequence of elements. From GroupByExtensions
GroupByManyToMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, IEnumerable<TElement>>)	IEnumerable<IGrouping<TKey, TElement>>	Groups the elements of a sequence according to a specified key selector function that returns a sequence of keys and projects the elements for each group by using a specified function that returns a sequence of elements. From GroupByExtensions
ParallelForEachAsync<IModule>(Func<IModule, Task>, CancellationToken)	Task	From ParallelAsyncExtensions
ParallelSelectAsync<IModule, TResult>(Func<IModule, Task<TResult>>, CancellationToken)	Task<IEnumerable<TResult>>	Invokes an async selector in parallel. From ParallelAsyncExtensions
ParallelSelectManyAsync<IModule, TResult>(Func<IModule, Task<IEnumerable<TResult>>>, CancellationToken)	Task<IEnumerable<TResult>>	Invokes an async selector that returns multiple results in parallel. From ParallelAsyncExtensions
ParallelWhereAsync<IModule>(Func<IModule, Task<bool>>, CancellationToken)	Task<IEnumerable<TSource>>	From ParallelAsyncExtensions
StartsWith<IModule>(IEnumerable<IModule>, IEqualityComparer<IModule>)	bool	Determines whether the items starts with the specified values. From IEnumerableExtensions
StartsWith<IModule>(IEnumerable<IModule>)	bool	Determines whether the items starts with the specified values. From IEnumerableExtensions
ThrowIfNull<ChildDocumentsModule>(string)	T	From GuardExtensions
ToDocument<ChildDocumentsModule>(IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ChildDocumentsModule>(IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ChildDocumentsModule>(NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ChildDocumentsModule>(NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ChildDocumentsModule>(NormalizedPath, NormalizedPath, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocument<ChildDocumentsModule>(NormalizedPath, NormalizedPath, IEnumerable<KeyValuePair<string, object>>, IContentProvider)	IDocument	From ObjectToDocumentExtensions
ToDocuments<IModule>(Func<IModule, IContentProvider>)	IEnumerable<IDocument>	From ObjectToDocumentExtensions
ToDocuments<IModule>(Func<IModule, IEnumerable<KeyValuePair<string, object>>>, Func<IModule, IContentProvider>)	IEnumerable<IDocument>	From ObjectToDocumentExtensions
ToDocuments<IModule>(Func<IModule, NormalizedPath>, Func<IModule, IContentProvider>)	IEnumerable<IDocument>	From ObjectToDocumentExtensions
ToDocuments<IModule>(Func<IModule, NormalizedPath>, Func<IModule, IEnumerable<KeyValuePair<string, object>>>, Func<IModule, IContentProvider>)	IEnumerable<IDocument>	From ObjectToDocumentExtensions
ToDocuments<IModule>(Func<IModule, NormalizedPath>, Func<IModule, NormalizedPath>, Func<IModule, IContentProvider>)	IEnumerable<IDocument>	From ObjectToDocumentExtensions
ToDocuments<IModule>(Func<IModule, NormalizedPath>, Func<IModule, NormalizedPath>, Func<IModule, IEnumerable<KeyValuePair<string, object>>>, Func<IModule, IContentProvider>)	IEnumerable<IDocument>	From ObjectToDocumentExtensions
ToLookupMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, TElement>, IEqualityComparer<TKey>)	ILookup<TKey, TElement>	Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys. The keys are compared by using a comparer and each group's elements are projected by using a specified function. From ToLookupExtensions
ToLookupMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, TElement>)	ILookup<TKey, TElement>	Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys and projects the elements for each group by using a specified function. From ToLookupExtensions
ToLookupMany<IModule, TKey>(Func<IModule, IEnumerable<TKey>>, IEqualityComparer<TKey>)	ILookup<TKey, TSource>	Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys and compares the keys by using a specified comparer. From ToLookupExtensions
ToLookupMany<IModule, TKey>(Func<IModule, IEnumerable<TKey>>)	ILookup<TKey, TSource>	Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys. From ToLookupExtensions
ToLookupManyToMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, IEnumerable<TElement>>, IEqualityComparer<TKey>)	ILookup<TKey, TElement>	Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys. The keys are compared by using a comparer and each group's elements are projected by using a specified function that returns a sequence of elements. From ToLookupExtensions
ToLookupManyToMany<IModule, TKey, TElement>(Func<IModule, IEnumerable<TKey>>, Func<IModule, IEnumerable<TElement>>)	ILookup<TKey, TElement>	Creates a lookup from a sequence according to a specified key selector function that returns a sequence of keys and projects the elements for each group by using a specified function that returns a sequence of elements. From ToLookupExtensions
ToStringTable<IModule>(string[], Func<IModule, object>[])	string	From ToStringTableExtensions
WithChildren<ChildDocumentsModule>(IEnumerable<IModule>)	TModule	From ParentModuleExtensions
WithChildren<ChildDocumentsModule>(IModule[])	TModule	From ParentModuleExtensions