update for 2.9.0/2.9.7

Author: vsch

resources/assets/js/helpers/Subscriptions.js

@@ -1,14 +1,27 @@
-export function unsubscribeListener(subscribers, listener) {
+function unsubscribeListener(subscribers, listener) {
  const index = subscribers.indexOf(listener);
  if (index >= 0) subscribers.splice(index, 1);
 }
 
+/**
+ * Subscribe listener and get function for unsubscribe
+ *
+ * @param subscribers {array} subscribers array
+ * @param listener {function} callback to invoke on notification
+ * @return {function(): void} function which will unsubscribe listener
+ */
 export function subscribeListener(subscribers, listener) {
  const index = subscribers.indexOf(listener);
  if (index < 0) subscribers.push(listener);
  return () => unsubscribeListener(subscribers, listener);
 }
 
+/**
+ * Inform listeners and pass parameters
+ *
+ * @param origSubscribers {array} subscribers
+ * @param params parameters to pass to listener
+ */
 export function informListeners(origSubscribers, ...params) {
  const subscribers = Object.assign([], origSubscribers);
 
@@ -25,16 +38,24 @@ export function informListeners(origSubscribers, ...params) {
  if (!unsubscribe) {
  unsubscribe = [];
  }
- unsubscribe.push(subscriber);
- console.error("GlobalSettingsHandler listener error for ", i, subscriber, params, subscribers, e)
+ Array.push.call(unsubscribe, subscriber);
+ console.error("informListeners() listener error for ", i, subscriber, params, subscribers, e);
  }
  }
 
  if (unsubscribe) {
- unsubscribe.forEach((subscriber) => unsubscribeListener(subscribers, subscriber));
+ Array.forEach.call(unsubscribe, (subscriber) => unsubscribeListener(origSubscribers, subscriber));
  }
 }
 
+/**
+ * Create subscriber with subscriptions to N signals
+ * 
+ * Last argument is the callback function for all subscriptions
+ * 
+ * Other arguments are targets supporting subscribe(function(){}) method to generate callback and returning function
+ * to call to unsubscribe
+ */
 export class Subscriber {
  constructor() {
  this._unsubscribe = [];
@@ -55,6 +76,9 @@ export class Subscriber {
  this.unsubscribe = this.unsubscribe.bind(this);
  }
 
+ /**
+ * Unsubscribe from all subscriptions
+ */
  unsubscribe() {
  let tmp = this._unsubscribe;
  this._unsubscribe = null;