Mercurial > irccd

diff doc/src/js/module/Irccd.Server/Irccd.Server.list.md @ 817:ebe561276c33

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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.Server/Irccd.Server.list.md@ebdc614db066
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/src/js/module/Irccd.Server/Irccd.Server.list.md	Mon Nov 19 07:04:42 2018 +0100
@@ -0,0 +1,25 @@
+# Function Irccd.Server.list
+
+List all servers in a map.
+
+# Synopsis
+
+```javascript
+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.
+}
+```