Class Logger

constructor

• new Logger(config?: LoggerConfig): Logger

• Creates a new instance of the Logger class.

  Parameters

  • config: LoggerConfig = {}

    The configuration options for the logger.

  Returns Logger

Readonlystyles

appName

• appName(): string

• Gets the application name.

  Returns string

d

• d(...args: any[]): this

• Logs the given message content to the console at the debug log level. If config.debug is false, this method does nothing.

  Parameters

  • ...args: any[]

  Returns this

  This logger instance.

e

• e(...args: any[]): this

• Logs an error message with the specified arguments.

  Parameters

  • ...args: any[]

  Returns this

  The logger instance.

getConfig

• getConfig(): LoggerConfig

• Returns the current logger configuration.

  Returns LoggerConfig

StaticgetInstance

• getInstance(config?: LoggerConfig): Logger

• Returns the singleton instance of the Logger class. If no instance has been created yet, it will create a new one with the given configuration. If an instance already exists, it will return the existing instance and set the given configuration.

  Parameters

  • config: LoggerConfig = {}

    The configuration options for the logger.

  Returns Logger

i

• i(...args: any[]): this

• Logs an info message with the specified arguments.

  Parameters

  • ...args: any[]

  Returns this

  The logger instance.

l

• l(...args: any[]): this

• Logs a normal message with the specified arguments.

  Parameters

  • ...args: any[]

  Returns this

  The logger instance.

registerPlugin

• registerPlugin(plugin: BasePlugin | BasePlugin[]): void

• Registers one or multiple plugins with the logger. Plugins can be added after the logger is instantiated. If a plugin has an initialize method, it will be executed immediately after registration.

  Parameters

  • plugin: BasePlugin | BasePlugin[]

    A single plugin or an array of plugins to register with the logger.

  Returns void

s

• s(...args: any[]): this

• Logs a success message with the specified arguments.

  Parameters

  • ...args: any[]

  Returns this

  The logger instance.

setConfig

• setConfig(config: LoggerConfig): this

• Sets the configuration options for the logger.

  Parameters

  • config: LoggerConfig

  Returns this

throw

• throw(message: unknown, errName?: string): void

• Throws an error with the specified message and error name. If errName is not provided, the default error name is used. If message is a string, a new error is created with the given message. If message is an error, the error is cloned and the error name is set. If message is any other type, the error message is set to the stringified value of message.

  Parameters

  • message: unknown

    the error message or error object to throw
  • OptionalerrName: string

    the name of the error, defaults to DEFAULT_ERROR_NAME

  Returns void

unregisterPlugin

• unregisterPlugin(pluginName: string | string[]): void

• Unregisters a plugin from the logger by its name. If the plugin has a destroy method, it will be called before the plugin is removed.

  Parameters

  • pluginName: string | string[]

    The name of the plugin to unregister. Can be a string or an array of strings.

  Returns void

w

• w(...args: any[]): this

• Logs a warning message with the specified arguments.

  Parameters

  • ...args: any[]

  Returns this

  The logger instance.