Kaydet (Commit) 2c2207cc authored tarafından Ali's avatar Ali

Added missing comments

üst 71879178
...@@ -2,6 +2,8 @@ import LogTypes, { Levels } from './LogTypes' ...@@ -2,6 +2,8 @@ import LogTypes, { Levels } from './LogTypes'
import LogServer from './LogServer' import LogServer from './LogServer'
import Colors from './Colors' import Colors from './Colors'
// inspired by: https://stackify.com/php-monolog-tutorial/
/** /**
* @description Logger class. This class will have logging functions * @description Logger class. This class will have logging functions
* @class Logger * @class Logger
...@@ -54,10 +56,28 @@ class Logger { ...@@ -54,10 +56,28 @@ class Logger {
return `${date} ${time}` return `${date} ${time}`
} }
/**
* @description This method will help to customize log messages.
* @param formatStr - The string which will formatted
* @todo
*/
public setFormat(formatStr: string) { public setFormat(formatStr: string) {
this.isFormatted = true this.isFormatted = true
} }
/**
* @description This method helps to prepare output message
* @param details - An object
* @example
*
* const messageData = {
* foregroundColor: colors.FgWhite,
* backgroundColor: colors.BgRed,
* levelName: levelName,
* message: message,
* reset: colors.Reset
* }
*/
private setMessage(details: any) { private setMessage(details: any) {
const logDate = this.getDateWithTime() const logDate = this.getDateWithTime()
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment