1
0
Fork 0
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:
Chris Fung 2018-10-22 14:53:40 -07:00
parent 9e04563ae0
commit 7b67a751ef
No known key found for this signature in database
GPG key ID: E89B5EC467AC51D8

View file

@ -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