base package​
Classes​
| Class | Description |
|---|---|
| ConfigurationManagerBase | A static class used to manage the log-right configuration data |
| ResultBase | A 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​
| Interface | Description |
|---|---|
| Event_2 | Data used to identify a specific system event |
| EventConfig | Configuration parameters to be applied to a specific event type |
| FormattedData | The base interface definition for FormattedData, the data generated on the Report instance when the format method is ran |
| Indexable | A default dictionary type that can be indexed via a string |
| IResult | The base interface definition for the Result class |
| Report | The base interface definition for Report |
| ReportConfigBase | Report configuration parameters to be applied to a specific event type |
| ResultConfigBase | Result object configuration parameters to be applied to a specific event type |
| TypedIndexable | A default dictionary type that can be indexed via a string and containing specific values |
| UserConfig | Configuration data that is specific to the current, active user |
Variables​
| Variable | Description |
|---|---|
| captureStringToConsole | A method to write message directly to the console |
| captureToConsole | A method to capture Report events directly to the console |
| DefaultEventTypes | |
| DefaultLogEventConfigBase | |
| DefaultLogRightConfigBase | |
| DefaultUserConfigBase | Configuration data that is specific to the current, active user |
| formatBase | A helper function that will handle converting the Result objects returned from a failed process into a Report |
| getConfig | An internal function used by the ConfigurationManager to get the configuration object |
| isErrorObject | A type-check function to verify if the passed in field is an Error object |
| isResultBase | A type-check function to verify if the passed in field is a Result object |
| setConfig | An internal function used by the ConfigurationManager to get the configuration object |
| SeverityTypes | The potential values of the severity field. Higher values indicate a more damaging event. If the severity is NONE (or 0), the condition will never be be met. If the severity is CRITICAL (or 99), the condition will always be be met. |
Type Aliases​
| Type Alias | Description |
|---|---|
| CallbackFunction | The function definition for any implementations of callback. This function is user-defined, and will be called when a specified result is called. |
| CaptureFunctionBase | The function definition for any implementations of capture. Custom user-defined methods should be sure to align with this. |
| DefaultEventType | The event types provided by default by log-right |
| EventType | |
| FormatFunctionBase | The function definition for any implementations of format. Custom user-defined methods should be sure to align with this. |
| LogEventConfigBase | A 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 |
| LogRightConfigBase | Specifications for the base level of configuration parameters log-right accepts |
| ResultBaseParams | Parameters that can be passed into the ResultBase class's constructor to initialize an object |
| Severity | The potential values of the severity field. Higher values indicate a more damaging event. If the severity is NONE (or 0), the condition will never be be met. If the severity is CRITICAL (or 99), the condition will always be be met. |