ParentSquare/faulty

View on GitHub
lib/faulty/events/listener_interface.rb

Summary

Maintainability
A
0 mins
Test Coverage
# frozen_string_literal: true

class Faulty
  module Events
    # The interface required to implement a event listener
    #
    # This is for documentation only and is not loaded
    class ListenerInterface
      # Handle an event raised by Faulty
      #
      # @param event [Symbol] The event name. Will be a member of {EVENTS}.
      # @param payload [Hash] A hash with keys based on the event type
      # @return [void]
      def handle(event, payload)
      end
    end
  end
end