@log-right/base > ConfigurationManagerBase
ConfigurationManagerBase class​
A static class used to manage the log-right configuration data
Signature:export declare class ConfigurationManagerBase
Properties​
Property | Modifiers | Type | Description |
---|---|---|---|
getConfig | static | () => LogRightConfigBase | Get the current log configuration object |
getConfigItem | static | <T = unknown>(name: string) => T | Get an item from the current log configuration object |
getLogEventConfig | static | (type: string) => LogEventConfigBase | Get the current configuration for a specified log event type |
getLogEventRegistry | static | () => TypedIndexable<LogEventConfigBase> | Get all of the current configurations for the defined for log event types |
init | static | <TLogRightConfig extends LogRightConfigBase<LogEventConfigBase<import("./types").ResultConfigBase<import("./types").CallbackFunction<unknown, import("./types").IResult<unknown, any, any>, unknown, import("./types").IResult<unknown, any, any>>>, import("./types").ReportConfigBase<import("./types").FormatFunctionBase<unknown, import("./types").IResult<unknown, any, any>, import("./types").FormattedData, import("./types").Report<import("./types").FormattedData>, import("./types").IResult<import("./types").Report<import("./types").FormattedData>, any, any>>, import("./types").CaptureFunctionBase<import("./types").FormattedData, import("./types").Report<import("./types").FormattedData>, unknown, import("./types").IResult<unknown, any, any>>>>, import("./types").UserConfig> = LogRightConfigBase<LogEventConfigBase<import("./types").ResultConfigBase<import("./types").CallbackFunction<unknown, import("./types").IResult<unknown, any, any>, unknown, import("./types").IResult<unknown, any, any>>>, import("./types").ReportConfigBase<import("./types").FormatFunctionBase<unknown, import("./types").IResult<unknown, any, any>, import("./types").FormattedData, import("./types").Report<import("./types").FormattedData>, import("./types").IResult<import("./types").Report<import("./types").FormattedData>, any, any>>, import("./types").CaptureFunctionBase<import("./types").FormattedData, import("./types").Report<import("./types").FormattedData>, unknown, import("./types").IResult<unknown, any, any>>>>, import("./types").UserConfig>>(defaultConfig?: TLogRightConfig) => boolean | A function used to initialize the configuration in memory |
setConfig | static | (params?: Partial<LogRightConfigBase<LogEventConfigBase<import("./types").ResultConfigBase<import("./types").CallbackFunction<unknown, import("./types").IResult<unknown, any, any>, unknown, import("./types").IResult<unknown, any, any>>>, import("./types").ReportConfigBase<import("./types").FormatFunctionBase<unknown, import("./types").IResult<unknown, any, any>, import("./types").FormattedData, import("./types").Report<import("./types").FormattedData>, import("./types").IResult<import("./types").Report<import("./types").FormattedData>, any, any>>, import("./types").CaptureFunctionBase<import("./types").FormattedData, import("./types").Report<import("./types").FormattedData>, unknown, import("./types").IResult<unknown, any, any>>>>, import("./types").UserConfig>> | undefined) => boolean | Set the configuration for how logging should be handled |
setConfigItem | static | (name: string, value: unknown) => boolean | Set a specific item value on the configuration object |
tryGetLogEventConfig | static | (type: string) => LogEventConfigBase | undefined | Get the current configuration for a specified log event type |