Skip to main content

@log-right/base > ConfigurationManagerBase

ConfigurationManagerBase classโ€‹

A static class used to manage the log-right configuration data

Signature:
export declare class ConfigurationManagerBase 

Propertiesโ€‹

PropertyModifiersTypeDescription
getConfigstatic() => LogRightConfigBaseGet the current log configuration object
getConfigItemstatic<T = unknown>(name: string) => TGet an item from the current log configuration object
getLogEventConfigstatic(type: string) => LogEventConfigBaseGet the current configuration for a specified log event type
getLogEventRegistrystatic() => TypedIndexable<LogEventConfigBase>Get all of the current configurations for the defined for log event types
initstatic<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) => booleanA function used to initialize the configuration in memory
setConfigstatic(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) => booleanSet the configuration for how logging should be handled
setConfigItemstatic(name: string, value: unknown) => booleanSet a specific item value on the configuration object
tryGetLogEventConfigstatic(type: string) => LogEventConfigBase | undefinedGet the current configuration for a specified log event type