mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
Add docs to ActiveSupport::Notifications.subscribe
[ci skip]
This commit is contained in:
parent
9e04563ae0
commit
7b67a751ef
1 changed files with 18 additions and 0 deletions
|
@ -171,6 +171,24 @@ module ActiveSupport
|
|||
end
|
||||
end
|
||||
|
||||
# Subscribe to a given event name with the passed +block+.
|
||||
#
|
||||
# You can subscribe to events by passing a String to match exact event
|
||||
# names, or by passing a Regexp to match all events that match a pattern.
|
||||
#
|
||||
# ActiveSupport::Notifications.subscribe(/render/) do |*args|
|
||||
# ...
|
||||
# end
|
||||
#
|
||||
# The +block+ will receive five parameters with information about the event:
|
||||
#
|
||||
# ActiveSupport::Notifications.subscribe('render') do |name, start, finish, id, payload|
|
||||
# name # => String, name of the event (such as 'render' from above)
|
||||
# start # => Time, when the instrumented block started execution
|
||||
# finish # => Time, when the instrumented block ended execution
|
||||
# id # => String, unique ID for the instrumenter that fired the event
|
||||
# payload # => Hash, the payload
|
||||
# end
|
||||
def subscribe(*args, &block)
|
||||
notifier.subscribe(*args, &block)
|
||||
end
|
||||
|
|
Loading…
Reference in a new issue