Mercurial > irccd

annotate doc/src/js/module/Irccd.Server/Irccd.Server.find.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.find.md@ebdc614db066
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
614
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
1 # Function Irccd.Server.find
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
2
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
3 Find a server by name.
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
4
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
5 # Synopsis
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
6
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
7 ```javascript
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
8 server = Irccd.Server.find(name)
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
9 ```
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
10
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
11 # Arguments
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
12
817
ebe561276c33 doc: start reworking, continue #752 @8h
David Demelier <markand@malikania.fr>
parents: 614
diff changeset
13 - name: the server name.
614
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
14
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
15 # Returns
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
16
ebdc614db066 Docs: get rid of metadata
David Demelier <markand@malikania.fr>
parents: 607
diff changeset
17 The server object or undefined if not found.