Issue 4878 - Start using ESLint for adblockpluscore

lib/filterNotifier.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 10 matching lines @@
  * @fileOverview This component manages listeners and calls them to distributes
  * messages about filter changes.
  */
 
 const {EventEmitter} = require("events");
 const {desc} = require("coreUtils");
 
 const CATCH_ALL = "__all";
 
 /**
- * @callback FilterNotifierOnListener

[Wladimir Palant, 2017/03/02 14:06:52]

This is a rather weird callback name. How about FilterNotifierCatchAllListener?

[kzar, 2017/03/08 12:33:38]

Done.

+ * @callback FilterNotifierCatchAllListener
  * @param {string} action
  * @param {Subscription|Filter} item
- * @param {*} newValue
- * @param {*} oldValue

[Wladimir Palant, 2017/03/02 14:06:53]

newValue and oldValue isn't really correct, it rather depends on the action. So
I'd suggest:

  @param{...*} additionalInfo

[kzar, 2017/03/08 12:33:37]

Done.

+ * @param {...*} additionalInfo
  */
 
 /**
  * This class allows registering and triggering listeners for filter events.
  * @class
  */
 exports.FilterNotifier = Object.create(new EventEmitter(), desc({
   /**
    * Adds a listener
    *
    * @deprecated use FilterNotifier.on(action, callback)
-   * @param {FilterNotifierOnListener} listener
+   * @param {FilterNotifierCatchAllListener} listener
    */
   addListener(listener)
   {
     let listeners = this._listeners[CATCH_ALL];
     if (!listeners || listeners.indexOf(listener) == -1)
       this.on(CATCH_ALL, listener);
   },
 
   /**
    * Removes a listener that was previosly added via addListener
    *
    * @deprecated use FilterNotifier.off(action, callback)
-   * @param {FilterNotifierOnListener} listener
+   * @param {FilterNotifierCatchAllListener} listener
    */
   removeListener(listener)
   {
     this.off(CATCH_ALL, listener);
   },
 
   /**
    * Notifies listeners about an event
    * @param {string} action event code ("load", "save", "elemhideupdate",
    *                 "subscription.added", "subscription.removed",
    *                 "subscription.disabled", "subscription.title",
    *                 "subscription.lastDownload", "subscription.downloadStatus",
    *                 "subscription.homepage", "subscription.updated",
    *                 "filter.added", "filter.removed", "filter.moved",
    *                 "filter.disabled", "filter.hitCount", "filter.lastHit")
    * @param {Subscription|Filter} item item that the change applies to
    * @param {*} param1
    * @param {*} param2
    * @param {*} param3

[Wladimir Palant, 2017/03/02 14:06:53]

Convert this to rest parameters?

[kzar, 2017/03/08 12:33:37]

Mind if I don't for now?

    * @deprecated use FilterNotifier.emit(action)
    */
   triggerListeners(action, item, param1, param2, param3)
   {
     this.emit(action, item, param1, param2, param3);
     this.emit(CATCH_ALL, action, item, param1, param2, param3);
   }
 }));