Reads text provided to the application on startup.
- Namespace
- Statiq
.Core - Interfaces
- Base Types
-
- object
- Module
- SyncModule
graph BT
Type-->Base0["SyncModule"]
click Base0 "/api/Statiq.Common/SyncModule"
Base0-->Base1["Module"]
click Base1 "/api/Statiq.Common/Module"
Base1-->Base2["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type["ReadApplicationInput"]
class Type type-node
Syntax
public class ReadApplicationInput : SyncModule, IModuleRemarks
This modules creates a single document from text provided to Statiq on startup. In most cases, this will be text or file contents
"piped" to the Statiq.exe via the command line from a file or prior chained executable. Also known as "Standard Input" or "STDIN".
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
|
| ExecuteContext |
IEnumerable |
Executes the module once for all input documents.
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
Inherited from SyncModule
|
| ExecuteInput |
IEnumerable |
Executes the module.
Inherited from SyncModule
|
| ExecuteInputAsync |
Task |
Executes the module.
Inherited from SyncModule
|
| 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
|