Class LogFactory

Builds implementations of [[ILogger]].

Index

Constructors

Methods

getLogger getCustomLogger getDefaultLogger

Constructors

constructor

new LogFactory(
    appConfig: AppConfig,
    logLevel?: LogLevel,
    logFormat?: LogFormat,
    logTimestamp?: boolean,
): LogFactory
Build a new log factory using application config.
Parameters
- appConfig: AppConfig
  Config object to read logging config from.
- logLevel: LogLevel = LogLevel.info
  (Optional) Lowest level to log, defaults to info.
- logFormat: LogFormat = "string"
  (Optional) Format to output log messages in, defaults to string.
- logTimestamp: boolean = false
  (Optional) Print an ISO 8601 timestamp before every log message? (string format only, defaults to false).
Returns LogFactory
- Defined in src/util/logging/LogFactory.ts:19

Methods

getLogger

getLogger(clazz: Function): ILogger
Create a new logger.
Parameters
- clazz: Function
  The enclosing class that will use the new logger.
Returns ILogger
- Defined in src/util/logging/LogFactory.ts:46

`Static`getCustomLogger

getCustomLogger(
    clazz: Function,
    level?: LogLevel,
    format?: LogFormat,
    logTimestamp?: boolean,
): ILogger
Create a new logger using custom log configuration.
Parameters
- clazz: Function
  The enclosing class that will use the new logger.
- level: LogLevel = LogLevel.info
  (Optional) Lowest level to log, defaults to info.
- format: LogFormat = "string"
  (Optional) Format to output log messages in, defaults to string.
- logTimestamp: boolean = false
  (Optional) Print an ISO 8601 timestamp before every log message? (string format only, defaults to false).
Returns ILogger
- Defined in src/util/logging/LogFactory.ts:70

`Static`getDefaultLogger

getDefaultLogger(clazz: Function): ILogger
Create a new logger using [[AppConfig]] config defaults.
Parameters
- clazz: Function
  The enclosing class that will use the new logger.
Returns ILogger
- Defined in src/util/logging/LogFactory.ts:55