Filters the current sequence of documents by source.
- Namespace
- Statiq
.Core - Interfaces
- Base Types
-
- object
- Module
- ConfigModule
<IEnumerable <string> > - SyncConfigModule
<IEnumerable <string> >
graph BT
Type-->Base0["SyncConfigModule<IEnumerable<string>>"]
Base0-->Base1["ConfigModule<IEnumerable<string>>"]
Base1-->Base2["Module"]
click Base2 "/api/Statiq.Common/Module"
Base2-->Base3["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type["FilterSources"]
class Type type-node
Syntax
public class FilterSources : SyncConfigModule<IEnumerable<string>>, IModuleRemarks
This module filters documents using "or" logic. If you want to also apply
"and" conditions, place additional
FilterSources modules
after this one.
Constructors
| Name | Summary |
|---|---|
| FilterSources |
Filters input document by using globbing pattern(s) on the document source. |
| FilterSources |
Filters input document by using globbing pattern(s) on the document source. |
| FilterSources |
Filters input document by using globbing pattern(s) on the document source. |
| FilterSources |
Filters input document by using globbing pattern(s) on the document source. |
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 |
|
| 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
|