view doc/html/api/module/Irccd.Logger/index.md @ 512:b8da1d8c2a72

Docs: use ``` as fenced code blocks
author David Demelier <markand@malikania.fr>
date Fri, 20 Oct 2017 11:43:36 +0200
parents 48676ca7071c
children
line wrap: on
line source

---
module: Irccd.Logger
js: true
summary: "Logging functions."
---

## Usage

This module must be used to log something. It will add messages to the logging system configured in the irccd.conf file.

For instance, if user has chosen to log into syslog, this module will log at syslog too.

Any plugin can log messages, the message will be prepended by the plugin name to be easily identifiable.

## Functions

  - [debug](Irccd.Logger.debug.html)
  - [info](Irccd.Logger.info.html)
  - [warning](Irccd.Logger.warning.html)

## Example

```javascript
function onLoad()
{
    Irccd.Logger.info("This is an example");
}
```