Joins documents together with an optional delimiter to form one document.
- Namespace
- Statiq
.Core - Interfaces
- Base Types
-
- object
- Module
graph BT
Type-->Base0["Module"]
click Base0 "/api/Statiq.Common/Module"
Base0-->Base1["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type["JoinDocuments"]
class Type type-node
Syntax
public class JoinDocuments : Module, IModuleConstructors
| Name | Summary |
|---|---|
| JoinDocuments |
Concatenates multiple documents together to form a single document without a delimiter and with the default metadata only. |
| JoinDocuments |
Concatenates multiple documents together to form a single document without a delimiter using the specified meta data mode. |
| JoinDocuments |
Concatenates multiple documents together to form a single document with a specified delimiter using the specified meta data mode. |
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
|
| ExecuteContextAsync |
Task |
Returns a single document containing the concatenated content of all input documents with an optional delimiter and configurable metadata options.
|
| ExecuteInputAsync |
Task |
Executes the module.
Inherited from Module
|
| 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
|