Outputs log messages during execution.
- Namespace
- Statiq
.Core - Interfaces
- Base Types
-
- object
- Module
- ConfigModule
<string> - SyncConfigModule
<string>
graph BT
Type-->Base0["SyncConfigModule<string>"]
Base0-->Base1["ConfigModule<string>"]
Base1-->Base2["Module"]
click Base2 "/api/Statiq.Common/Module"
Base2-->Base3["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type["LogMessage"]
class Type type-node
Syntax
public class LogMessage : SyncConfigModule<string>, IModuleRemarks
This module has no effect on documents and the input documents are passed through to output documents.
Constructors
| Name | Summary |
|---|---|
| LogMessage |
Logs the string value of the returned object. This allows you to log different content for each document depending on the input document. |
| LogMessage |
Logs the string value of the returned object with a specified log level. This allows you to log different content for each document depending on the input document. |
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
|