path: root/docs/02-event-reference.md
diff options
Diffstat (limited to 'docs/02-event-reference.md')
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/02-event-reference.md b/docs/02-event-reference.md
index f2bed7b..d990307 100644
--- a/docs/02-event-reference.md
+++ b/docs/02-event-reference.md
@@ -55,6 +55,18 @@ irc-addressed ▶ irc-to-me ▶ irc-notice-channel ▶ irc-notice
+**Note:** `irc-started` is a special event that's exempt from the rules
+applicable to all other events and their event handlers:
+* It's called just once per call of `IRC::Client`'s `.run` method, regardless
+of how many times the client reconnects
+* When it's called, there's no guarantee the connections to servers have
+been fully established yet or channels joined yet.
+* Unless all other event handlers, this one does not take any arguments
+* Return values from handlers are ignored and the event is propagated to all of
+the plugins
+* This event does not trigger `irc-all` event
## Up Next
Read [the method reference](03-method-reference.md) next.