Mercurial > irccd
diff doc/html/api/module/Irccd.Server/function/list.md @ 0:1158cffe5a5e
Initial import
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 08 Feb 2016 16:43:14 +0100 |
parents | |
children | 070a1ece2af6 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/html/api/module/Irccd.Server/function/list.md Mon Feb 08 16:43:14 2016 +0100 @@ -0,0 +1,18 @@ +--- +function: list +summary: "List all servers in a map." +synopsis: "table = Irccd.Server.list()" +returns: "the table of all servers." +--- + +Example: + +````javascript +var table = Irccd.Server.list(); + +for (var name in table) { + var server = table[name]; + + /* Use server */ +} +````