Index: lib/filterNotifier.js |
diff --git a/lib/filterNotifier.js b/lib/filterNotifier.js |
index 624b2bf48d3c0fa5e8008a5690800b471fa846ab..743c498d34bda0d511f51646689d4ee270d51f63 100644 |
--- a/lib/filterNotifier.js |
+++ b/lib/filterNotifier.js |
@@ -15,17 +15,27 @@ |
* along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. |
*/ |
+"use strict"; |
+ |
/** |
* @fileOverview This component manages listeners and calls them to distributes |
* messages about filter changes. |
*/ |
-let {EventEmitter} = require("events"); |
-let {desc} = require("coreUtils"); |
+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 Fi
kzar
2017/03/08 12:33:38
Done.
|
+ * @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 rat
kzar
2017/03/08 12:33:37
Done.
|
+ */ |
+ |
+/** |
* This class allows registering and triggering listeners for filter events. |
* @class |
*/ |
@@ -34,8 +44,9 @@ exports.FilterNotifier = Object.create(new EventEmitter(), desc({ |
* Adds a listener |
* |
* @deprecated use FilterNotifier.on(action, callback) |
+ * @param {FilterNotifierOnListener} listener |
*/ |
- addListener: function(/**function(action, item, newValue, oldValue)*/ listener) |
+ addListener(listener) |
{ |
let listeners = this._listeners[CATCH_ALL]; |
if (!listeners || listeners.indexOf(listener) == -1) |
@@ -46,15 +57,16 @@ exports.FilterNotifier = Object.create(new EventEmitter(), desc({ |
* Removes a listener that was previosly added via addListener |
* |
* @deprecated use FilterNotifier.off(action, callback) |
+ * @param {FilterNotifierOnListener} listener |
*/ |
- removeListener: function(/**function(action, item, newValue, oldValue)*/ listener) |
+ removeListener(listener) |
{ |
this.off(CATCH_ALL, listener); |
}, |
/** |
* Notifies listeners about an event |
- * @param {String} action event code ("load", "save", "elemhideupdate", |
+ * @param {string} action event code ("load", "save", "elemhideupdate", |
* "subscription.added", "subscription.removed", |
* "subscription.disabled", "subscription.title", |
* "subscription.lastDownload", "subscription.downloadStatus", |
@@ -62,9 +74,12 @@ exports.FilterNotifier = Object.create(new EventEmitter(), desc({ |
* "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: function(action, item, param1, param2, param3) |
+ triggerListeners(action, item, param1, param2, param3) |
{ |
this.emit(action, item, param1, param2, param3); |
this.emit(CATCH_ALL, action, item, param1, param2, param3); |