view doc/html/api/event/onWhois.md @ 15:8d74eeb81184

Docs: update documentation in the irccd JavaScript events
author David Demelier <markand@malikania.fr>
date Thu, 11 Feb 2016 13:48:53 +0100
parents 1158cffe5a5e
children 392778b6d3c9
line wrap: on
line source

---
event: onWhois
summary: "This event is triggered when irccd gets information about a user."
synopsis: "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.