githubEdit

Logger

Noir.Classes.Logger: NoirClass

Represents a logger, used for logging messages to chat and other places.

Functionality of loggers can be extended with LoggerMiddleware instances, allowing for

sending logs to other places - like a Discord webhook via HTTP.


Noir.Classes.Logger:Init(name)

Initializes Logger class objects.

Parameters

  • name: string


Noir.Classes.Logger:SetEnabled(enabled)

Sets whether the logger is enabled or not.

Parameters

  • enabled: boolean


Noir.Classes.Logger:IsEnabled()

Returns if the logger is enabled.

Returns

  • boolean


Sets the log filter.

Parameters

  • level: NoirLogLevel


Attaches middleware to this logger.

Parameters

  • middleware: NoirLoggerMiddleware


Sets the formatter for this logger.

Parameters

  • formatter: NoirLogFormatter


Returns the log level formatted a string.

Parameters

  • level: NoirLogLevel

Returns

  • string


Returns if this logger can handle a log level based on the logger's filter.

Parameters

  • level: NoirLogLevel

Returns

  • boolean


Returns all middleware attached to this logger.

Returns

  • table<integer, NoirLoggerMiddleware>


Propagates a log record to all attached middleware for processing.

Parameters

  • record: NoirLogRecord


Sends a log.

Parameters

  • level: NoirLogLevel

  • message: string

  • ...: any

Returns

  • NoirLogRecord


Sends a debug log.

Parameters

  • message: any

  • ...: any

Returns

  • NoirLogRecord


Sends an info log.

Parameters

  • message: any

  • ...: any

Returns

  • NoirLogRecord


Sends a success log.

Parameters

  • message: any

  • ...: any

Returns

  • NoirLogRecord


Sends a warning log.

Parameters

  • message: any

  • ...: any

Returns

  • NoirLogRecord


Sends an error log.

Parameters

  • message: any

  • ...: any

Returns

  • NoirLogRecord

Last updated