Skip to main content

log-more

log-more package​

Classes​

ClassDescription
ConfigurationManagerA static class used to manage the log-more configuration data
ResultA class used to handle the result of a function call or sub-process. Functions/process should return back this object so that the calling function can evaluate it's success.

Interfaces​

InterfaceDescription
ReportConfigReport configuration parameters to be applied to a specific event type

Variables​

VariableDescription
DefaultLogEventConfig
DefaultLogMoreConfig
formatA helper function that will handle converting the Result objects returned from a failed process into a Report
isErrorCheck a Result object's severity to determine if it should be treated as an error
isReportableCheck a Result object's severity to determine if it should be reported
isResultA type-check function to verify if the passed in field is a Result object
reportHandle the reporting of a Result object
validateA function called after a function/process is executed to determine if it was successful or not and report information using the user's previously defined configuration.

Type Aliases​

Type AliasDescription
CaptureFunctionThe function definition for any implementations of capture. Custom user-defined methods should be sure to align with this.
FormatFunctionThe function definition for any implementations of format. Custom user-defined methods should be sure to align with this.
LogEventConfigA type to represent a full log event sequence: - 1. A Result is returned from a function or process - 2. The Result is used to create (or format) a Report - 3. The Report is captured to help identify an issue or a more general event
LogMoreConfigSpecifications for the base level of configuration parameters Log-More accepts
ReportFunctionThe function definition for any implementations of Report. This function can be user-defined, and will be called when a specified result is called.
ResultConfigResult object configuration parameters to be applied to a specific event type