aboutsummaryrefslogtreecommitdiffstats
path: root/lib/plum/event_emitter.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/plum/event_emitter.rb')
-rw-r--r--lib/plum/event_emitter.rb4
1 files changed, 3 insertions, 1 deletions
diff --git a/lib/plum/event_emitter.rb b/lib/plum/event_emitter.rb
index 90484fc..572900e 100644
--- a/lib/plum/event_emitter.rb
+++ b/lib/plum/event_emitter.rb
@@ -1,12 +1,14 @@
module Plum
module EventEmitter
# Registers an event handler to specified event. An event can have multiple handlers.
- # @param name [String] The name of event.
+ # @param name [Symbol] The name of event.
# @yield Gives event-specific parameters.
def on(name, &blk)
(callbacks[name] ||= []) << blk
end
+ # Invokes an event and call handlers with args.
+ # @param name [Symbol] The identifier of event.
def callback(name, *args)
(cbs = callbacks[name]) && cbs.each {|cb| cb.call(*args) }
end