diff doc/src/js/event/onWhois.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/event/onWhois.md@ebdc614db066
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/src/js/event/onWhois.md	Mon Nov 19 07:04:42 2018 +0100
@@ -0,0 +1,22 @@
+# Event onWhois
+
+This event is triggered when irccd gets information about a user.
+
+# Synopsis
+
+```javascript
+function onWhois(server, info)
+```
+
+# Arguments
+
+- server: the current server,
+- info: the whois information.
+
+The info is an object with the following properties:
+
+- nickname: the user nickname,
+- user: the user name,
+- host: the hostname,
+- realname: the real name used,
+- channels: an optional list of channels joined.