Mercurial > irccd

annotate doc/html/api/module/Irccd.Server/function/list.md @ 13:070a1ece2af6

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Docs: fix various errors in JavaScript API
author David Demelier <markand@malikania.fr>
date Thu, 11 Feb 2016 22:02:57 +0100
parents 1158cffe5a5e
children 6635b9187d71
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 function: list
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 summary: "List all servers in a map."
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 synopsis: "table = Irccd.Server.list()"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 returns: "the table of all servers."
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
13
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
8 ## Example
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 ````javascript
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 var table = Irccd.Server.list();
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 for (var name in table) {
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 var server = table[name];
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 /* Use server */
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 }
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 ````