Class AbstractLogger`Abstract`

Hierarchy (view full)

AbstractLogger
- ConsoleLogger

Implemented by

ConsoleLogger

Index

Constructors

Properties

logLevel logTag

Methods

debug error extend fatal formatMessage info shouldLog trace warn

Constructors

`Protected`constructor

new AbstractLogger(logLevel?, logTag?): AbstractLogger
Parameters
- logLevel: LogLevel = 'error'
- logTag: string = defaultLogTag
Returns AbstractLogger
- Defined in src/types/logger.ts:19

Properties

`Protected`logLevel

logLevel: LogLevel

`Protected`logTag

logTag: string

Methods

`Abstract`debug

debug(...args): void
Debug logs are for information that is useful for debugging issues.
Parameters
- Rest...args: unknown[]
Returns void
- Defined in src/types/logger.ts:85

`Abstract`error

error(...args): void
Errors are for information that is critical and should be addressed immediately.
Parameters
- Rest...args: unknown[]
Returns void
- Defined in src/types/logger.ts:81

extend

extend(logTag): AbstractLogger
Extends the current logger with a new log tag.
Parameters
- logTag: string
  The new log tag to use
Returns AbstractLogger
A new logger instance with the new log tag
- Defined in src/types/logger.ts:58

`Abstract`fatal

fatal(...args): void
Fatal logs are for information that is critical and should be addressed immediately.
Parameters
- Rest...args: unknown[]
Returns void
- Defined in src/types/logger.ts:93

`Protected`formatMessage

formatMessage(level, ...args): string
Formats a message for logging, including the log level and log tag.
Parameters
- level: LogLevel
  The log level to use
- Rest...args: unknown[]
  The arguments to log
Returns string
The formatted message
- Defined in src/types/logger.ts:49

`Abstract`info

info(...args): void
General/generic information to log, typically for info that you want to have always available, but not necessarily important to the user. This is the default log level.
Parameters
- Rest...args: unknown[]
Returns void
- Defined in src/types/logger.ts:73

`Protected`shouldLog

shouldLog(level): boolean
Checks whether a log level should be logged based on the current log level.
Parameters
- level: LogLevel
  The log level to check
Returns boolean
Whether the log level should be logged
- Defined in src/types/logger.ts:36

`Abstract`trace

trace(...args): void
Trace logs are for information that is useful for tracing the flow of a program.
Parameters
- Rest...args: unknown[]
Returns void
- Defined in src/types/logger.ts:89

`Abstract`warn

warn(...args): void
Warnings are for information that is important to the user, but not necessarily critical.
Parameters
- Rest...args: unknown[]
Returns void
- Defined in src/types/logger.ts:77