view doc/src/js/module/Irccd/index.md @ 817:ebe561276c33

doc: start reworking, continue #752 @8h
author David Demelier <markand@malikania.fr>
date Mon, 19 Nov 2018 07:04:42 +0100
parents doc/src/api/module/Irccd/index.md@ebdc614db066
children
line wrap: on
line source

# Module Irccd

Contains general irccd variables and functions.

# Constants

The following properties are defined:

- version: (object)
  - major: (int) the major irccd version,
  - minor: (int) the minor irccd version,
  - patch: (int) the patch irccd version.

# Types

- SystemError: (function) an exception inheriting `Error` thrown by some
  functions.

# Example

```javascript
var Logger = Irccd.Logger;

function onLoad()
{
	Logger.info("Major: " + Irccd.version.major);
	Logger.info("Minor: " + Irccd.version.minor);
	Logger.info("Patch: " + Irccd.version.patch);
}
```