Class ConsoleLogger

Hierarchy (view full)

AbstractLogger
- ConsoleLogger

Implements

AbstractLogger

Index

Constructors

constructor

new ConsoleLogger(logLevel?, logTag?): ConsoleLogger
Creates a new console logger instance, which (as you might expect) logs messages to the console.
Parameters
- logLevel: LogLevel = 'error'
  The log level to use for this logger, defaults to 'error'.
- logTag: string = defaultLogTag
  The tag to use for this logger, defaults to this libraries (short) user agent.
Returns ConsoleLogger
See
LogLevel
Overrides AbstractLogger.constructor
- Defined in src/classes/logger.ts:30

Properties

`Protected`logLevel

logLevel: LogLevel

The log level to use for this logger.

off - Do not log any messages.
fatal - Only log fatal (error) messages.
error - Log all (error) messages (excludes warn, info, debug, and trace).
warn - Log all messages except info, debug, and trace.
info - Log all messages except debug and trace.
debug - Log all messages except trace.
trace - Log all messages.

See

LogLevel

Default

'error'

`Protected`logTag

logTag: string

The tag to use for this logger.

Methods

debug

debug(...args): void
Debug logs are for information that is useful for debugging issues.
Parameters
- Rest...args: unknown[]
Returns void
Implementation of AbstractLogger.debug
Overrides AbstractLogger.debug
- Defined in src/classes/logger.ts:64

error

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

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
Implementation of AbstractLogger.extend
Inherited from AbstractLogger.extend
- Defined in src/types/logger.ts:58

fatal

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

`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
Implementation of AbstractLogger.formatMessage
Inherited from AbstractLogger.formatMessage
- Defined in src/types/logger.ts:49

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
Implementation of AbstractLogger.info
Overrides AbstractLogger.info
- Defined in src/classes/logger.ts:40

`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
Implementation of AbstractLogger.shouldLog
Inherited from AbstractLogger.shouldLog
- Defined in src/types/logger.ts:36

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
Implementation of AbstractLogger.trace
Overrides AbstractLogger.trace
- Defined in src/classes/logger.ts:72

warn

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

Class ConsoleLogger

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ConsoleLogger

See

Properties

ProtectedlogLevel

See

Default

ProtectedlogTag

Methods

debug

Parameters

Returns void

error

Parameters

Returns void

extend

Parameters

Returns AbstractLogger

fatal

Parameters

Returns void

ProtectedformatMessage

Parameters

Returns string

info

Parameters

Returns void

ProtectedshouldLog

Parameters

Returns boolean

trace

Parameters

Returns void

warn

Parameters

Returns void

Settings

On This Page

`Protected`logLevel

`Protected`logTag

`Protected`formatMessage

`Protected`shouldLog