Contents

# frozen_string_literal: true

module Emittance
  ##
  # Can watch for events that propagate through the system.
  #
  module Watcher
    # Watch for an event, identified by its class' identifier. If a callback method is provided, then it will call that
    # method on the caller of +watch+ when the event happens. Otherwise, it will run the callback block.
    #
    # @param identifier [Symbol] the event's identifier
    # @param callback_method [Symbol] one option for adding a callback--the method on the object to call when the
    #   event fires
    # @param params [Hash] any parameters related to the registration of a watcher
    # @param callback [Block] the other option for adding a callback--the block you wish to be executed when the event
    #   fires
    # @return [Proc] the block that will run when the event fires
    def watch(identifier, callback_method = nil, **params, &callback)
      if callback
        _dispatcher(params).register identifier, params, &callback
      else
        _dispatcher(params).register_method_call identifier, self, callback_method, params
      end
    end

    private

    def _dispatcher(params)
      Emittance.dispatcher_for(params[:broker])
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
emittance-2.0.0.pre.1	lib/emittance/watcher.rb