Mercurial > irccd
diff doc/src/js/module/Irccd.Util/Irccd.Util.splituser.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.Util/Irccd.Util.splituser.md@ebdc614db066 |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/src/js/module/Irccd.Util/Irccd.Util.splituser.md Mon Nov 19 07:04:42 2018 +0100 @@ -0,0 +1,18 @@ +# Function Irccd.Util.splituser + +Extract the nickname, for instance with **foo!~foo@localhost**, **foo** will be +returned. + +# Synopsis + +```javascript +nick = Irccd.Util.splituser(user) +``` + +# Arguments + +- user: the user to split. + +# Returns + +The nickname.