ima/event/Dispatcher.js

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
/**
 * A Dispatcher is a utility that manager event listeners registered for events
 * and allows distributing (firing) events to the listeners registered for the
 * given event.
 *
 * The dispatcher provides a single-node event bus and is usually used to
 * propagate events from controllers to UI components when modifying/passing
 * the state is impractical for any reason.
 *
 * @interface
 */
class Dispatcher {
  /**
   * Deregisters all event listeners currently registered with this
   * dispatcher.
   *
   * @return {Dispatcher} This dispatcher.
   */
  clear() {}

  /**
   * Registers the provided event listener to be executed when the specified
   * event is fired on this dispatcher.
   *
   * When the specified event is fired, the event listener will be executed
   * with the data passed with the event as the first argument.
   *
   * The order in which the event listeners will be executed is unspecified
   * and should not be relied upon. Registering the same listener for the
   * same event and with the same scope multiple times has no effect.
   *
   * @param {string} event The name of the event to listen for.
   * @param {function(*)} listener The event listener to register.
   * @param {?Object=} scope The object to which the {@code this} keyword
   *        will be bound in the event listener.
   * @return {Dispatcher} This dispatcher.
   */
  listen() {}

  /**
   * Deregisters the provided event listener, so it will no longer be
   * executed with the specified scope when the specified event is fired.
   *
   * @param {string} event The name of the event for which the listener
   *        should be deregistered.
   * @param {function(*)} listener The event listener to deregister.
   * @param {?Object=} scope The object to which the {@code this} keyword
   *        would be bound in the event listener.
   * @return {Dispatcher} This dispatcher.
   */
  unlisten() {}

  /**
   * Fires a new event of the specified name, carrying the provided data.
   *
   * The method will synchronously execute all event listeners registered for
   * the specified event, passing the provided data to them as the first
   * argument.
   *
   * Note that this method does not prevent the event listeners to modify the
   * data in any way. The order in which the event listeners will be executed
   * is unspecified and should not be relied upon.
   *
   * @param {string} event The name of the event to fire.
   * @param {Object<string, *>} data The data to pass to the event listeners.
   * @param {boolean=} [imaInternalEvent=false] The flag signalling whether
   *        this is an internal IMA event. The fired event is treated as a
   *        custom application event if this flag is not set.
   *        The flag is used only for debugging and has no effect on the
   *        propagation of the event.
   * @return {Dispatcher} This dispatcher.
   */
  fire() {}
}
exports.default = Dispatcher;

typeof $IMA !== 'undefined' && $IMA !== null && $IMA.Loader && $IMA.Loader.register('ima/event/Dispatcher', [], function (_export, _context) {
 'use strict';
 return {
   setters: [],
   execute: function () {
     _export('default', exports.default);
   }
 };
});