OLD | NEW |
1 /* | 1 /* |
2 * This file is part of Adblock Plus <https://adblockplus.org/>, | 2 * This file is part of Adblock Plus <https://adblockplus.org/>, |
3 * Copyright (C) 2006-2016 Eyeo GmbH | 3 * Copyright (C) 2006-2016 Eyeo GmbH |
4 * | 4 * |
5 * Adblock Plus is free software: you can redistribute it and/or modify | 5 * Adblock Plus is free software: you can redistribute it and/or modify |
6 * it under the terms of the GNU General Public License version 3 as | 6 * it under the terms of the GNU General Public License version 3 as |
7 * published by the Free Software Foundation. | 7 * published by the Free Software Foundation. |
8 * | 8 * |
9 * Adblock Plus is distributed in the hope that it will be useful, | 9 * Adblock Plus is distributed in the hope that it will be useful, |
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of | 10 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | 11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12 * GNU General Public License for more details. | 12 * GNU General Public License for more details. |
13 * | 13 * |
14 * You should have received a copy of the GNU General Public License | 14 * You should have received a copy of the GNU General Public License |
15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. | 15 * along with Adblock Plus. If not, see <http://www.gnu.org/licenses/>. |
16 */ | 16 */ |
17 | 17 |
| 18 "use strict"; |
| 19 |
18 /** | 20 /** |
19 * @fileOverview This component manages listeners and calls them to distributes | 21 * @fileOverview This component manages listeners and calls them to distributes |
20 * messages about filter changes. | 22 * messages about filter changes. |
21 */ | 23 */ |
22 | 24 |
23 let {EventEmitter} = require("events"); | 25 const {EventEmitter} = require("events"); |
24 let {desc} = require("coreUtils"); | 26 const {desc} = require("coreUtils"); |
25 | 27 |
26 const CATCH_ALL = "__all"; | 28 const CATCH_ALL = "__all"; |
27 | 29 |
28 /** | 30 /** |
| 31 * @callback FilterNotifierCatchAllListener |
| 32 * @param {string} action |
| 33 * @param {Subscription|Filter} item |
| 34 * @param {...*} additionalInfo |
| 35 */ |
| 36 |
| 37 /** |
29 * This class allows registering and triggering listeners for filter events. | 38 * This class allows registering and triggering listeners for filter events. |
30 * @class | 39 * @class |
31 */ | 40 */ |
32 exports.FilterNotifier = Object.create(new EventEmitter(), desc({ | 41 exports.FilterNotifier = Object.create(new EventEmitter(), desc({ |
33 /** | 42 /** |
34 * Adds a listener | 43 * Adds a listener |
35 * | 44 * |
36 * @deprecated use FilterNotifier.on(action, callback) | 45 * @deprecated use FilterNotifier.on(action, callback) |
| 46 * @param {FilterNotifierCatchAllListener} listener |
37 */ | 47 */ |
38 addListener: function(/**function(action, item, newValue, oldValue)*/ listener
) | 48 addListener(listener) |
39 { | 49 { |
40 let listeners = this._listeners[CATCH_ALL]; | 50 let listeners = this._listeners[CATCH_ALL]; |
41 if (!listeners || listeners.indexOf(listener) == -1) | 51 if (!listeners || listeners.indexOf(listener) == -1) |
42 this.on(CATCH_ALL, listener); | 52 this.on(CATCH_ALL, listener); |
43 }, | 53 }, |
44 | 54 |
45 /** | 55 /** |
46 * Removes a listener that was previosly added via addListener | 56 * Removes a listener that was previosly added via addListener |
47 * | 57 * |
48 * @deprecated use FilterNotifier.off(action, callback) | 58 * @deprecated use FilterNotifier.off(action, callback) |
| 59 * @param {FilterNotifierCatchAllListener} listener |
49 */ | 60 */ |
50 removeListener: function(/**function(action, item, newValue, oldValue)*/ liste
ner) | 61 removeListener(listener) |
51 { | 62 { |
52 this.off(CATCH_ALL, listener); | 63 this.off(CATCH_ALL, listener); |
53 }, | 64 }, |
54 | 65 |
55 /** | 66 /** |
56 * Notifies listeners about an event | 67 * Notifies listeners about an event |
57 * @param {String} action event code ("load", "save", "elemhideupdate", | 68 * @param {string} action event code ("load", "save", "elemhideupdate", |
58 * "subscription.added", "subscription.removed", | 69 * "subscription.added", "subscription.removed", |
59 * "subscription.disabled", "subscription.title", | 70 * "subscription.disabled", "subscription.title", |
60 * "subscription.lastDownload", "subscription.downloadStatus", | 71 * "subscription.lastDownload", "subscription.downloadStatus", |
61 * "subscription.homepage", "subscription.updated", | 72 * "subscription.homepage", "subscription.updated", |
62 * "filter.added", "filter.removed", "filter.moved", | 73 * "filter.added", "filter.removed", "filter.moved", |
63 * "filter.disabled", "filter.hitCount", "filter.lastHit") | 74 * "filter.disabled", "filter.hitCount", "filter.lastHit") |
64 * @param {Subscription|Filter} item item that the change applies to | 75 * @param {Subscription|Filter} item item that the change applies to |
| 76 * @param {*} param1 |
| 77 * @param {*} param2 |
| 78 * @param {*} param3 |
65 * @deprecated use FilterNotifier.emit(action) | 79 * @deprecated use FilterNotifier.emit(action) |
66 */ | 80 */ |
67 triggerListeners: function(action, item, param1, param2, param3) | 81 triggerListeners(action, item, param1, param2, param3) |
68 { | 82 { |
69 this.emit(action, item, param1, param2, param3); | 83 this.emit(action, item, param1, param2, param3); |
70 this.emit(CATCH_ALL, action, item, param1, param2, param3); | 84 this.emit(CATCH_ALL, action, item, param1, param2, param3); |
71 } | 85 } |
72 })); | 86 })); |
OLD | NEW |