Class FlowrLogger

Hierarchy

Logger<ILogObj>
- FlowrLogger

Index

Constructors

Methods

getSubLogger logToFile updateSettings

Constructors

constructor

new FlowrLogger(
settings?: ISettingsParam<ILogObj>,
logObj?: ILogObj,
): FlowrLogger
Parameters
- Optionalsettings: ISettingsParam<ILogObj>
- OptionallogObj: ILogObj
Returns FlowrLogger
Inherited from Logger<ILogObj>.constructor
- Defined in node_modules/tslog/types/index.d.ts:11

Methods

getSubLogger

getSubLogger(
settings?: ISettingsParam<ILogObj>,
logObj?: ILogObj,
): Logger<ILogObj>
Returns a child logger based on the current instance with inherited settings
Parameters
- Optionalsettings: ISettingsParam<ILogObj>
  Overwrite settings inherited from parent logger
- OptionallogObj: ILogObj
  Overwrite logObj for sub-logger
Returns Logger<ILogObj>
Overrides Logger.getSubLogger
- Defined in src/util/log.ts:26

logToFile

logToFile(filename?: string, options?: Options): void
make the logger log to a file as well

Rotation needs the optional rotating-file-stream dependency. Without it (the slim runtime images install with --omit=optional) the log is appended to a single file instead.
Parameters
- filename: string = 'flowr.log'
- options: Options = ...
Returns void
- Defined in src/util/log.ts:48

updateSettings

updateSettings(updater: (logger: Logger<ILogObj>) => void): void
Parameters
- updater: (logger: Logger<ILogObj>) => void
Returns void
- Defined in src/util/log.ts:35