path: root/docs/03-method-reference.md
diff options
authorZoffix Znet <cpan@zoffix.com>2016-08-07 22:58:46 -0400
committerZoffix Znet <cpan@zoffix.com>2016-08-07 22:58:46 -0400
commitb1e795877f2447bc634cbb4b269f9ac8bebd67f3 (patch)
treecfc45f9e3f861f911d0d7294b9434956ad659e35 /docs/03-method-reference.md
parent8bb81d24b338773f0c56916f919e0457e0182970 (diff)
Add `:alias` feature3.006001
Closes #22
Diffstat (limited to 'docs/03-method-reference.md')
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/03-method-reference.md b/docs/03-method-reference.md
index 9c5f1fa..6963d64 100644
--- a/docs/03-method-reference.md
+++ b/docs/03-method-reference.md
@@ -354,6 +354,10 @@ the channel and the value is its password.
A list of nicks the client uses on this server. If one nick is
taken, next one in the list will be attempted to be used.
+#### `.alias`
+A list of aliases on this server.
#### `.host`
The host of the server.
@@ -445,6 +449,7 @@ my $irc = IRC::Client.new:
:channels<#perl #perl6 #rust-lang>
+ :alias('foo', /b.r/)
:userreal('Mah awesome bot!')
@@ -515,8 +520,22 @@ generate three additional nicknames that have underscores appended
If one of the given nicks is in use, the client will attempt to use the
next one in the list.
+##### `:alias`
**Defaults to:** `P6Bot`
+ :alias('foo', /b.r/)
+A list of `Str` or `Regex` objects that in the context of
+`irc-addressed`, `irc-to-me`, and `irc-mentioned` events will be used
+as alternative nicks. In other words, specifying `'bot'` as alias will allow
+you to address the bot using `bot` nick, regardless of the actual nick the
+bot is currently using.
+**Defaults to:** empty list
##### `:password`
The server password to use. On some networks (like Freenode), the server