Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Delta Between Two Patch Sets: lib/filterNotifier.js

Issue 29375915: Issue 4878 - Start using ESLint for adblockpluscore (Closed)
Left Patch Set: Rebased. Created Feb. 28, 2017, 3:55 p.m.
Right Patch Set: Removed unused imports Created March 15, 2017, 3:11 a.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
Left: Side by side diff | Download
Right: Side by side diff | Download
« no previous file with change/comment | « lib/filterListener.js ('k') | lib/filterStorage.js » ('j') | no next file with change/comment »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
LEFTRIGHT
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
(...skipping 10 matching lines...) Expand all
21 * @fileOverview This component manages listeners and calls them to distributes 21 * @fileOverview This component manages listeners and calls them to distributes
22 * messages about filter changes. 22 * messages about filter changes.
23 */ 23 */
24 24
25 const {EventEmitter} = require("events"); 25 const {EventEmitter} = require("events");
26 const {desc} = require("coreUtils"); 26 const {desc} = require("coreUtils");
27 27
28 const CATCH_ALL = "__all"; 28 const CATCH_ALL = "__all";
29 29
30 /** 30 /**
31 * @callback FilterNotifierOnListener 31 * @callback FilterNotifierCatchAllListener
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.
32 * @param {string} action 32 * @param {string} action
33 * @param {Subscription|Filter} item 33 * @param {Subscription|Filter} item
34 * @param {*} newValue 34 * @param {...*} additionalInfo
35 * @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.
36 */ 35 */
37 36
38 /** 37 /**
39 * This class allows registering and triggering listeners for filter events. 38 * This class allows registering and triggering listeners for filter events.
40 * @class 39 * @class
41 */ 40 */
42 exports.FilterNotifier = Object.create(new EventEmitter(), desc({ 41 exports.FilterNotifier = Object.create(new EventEmitter(), desc({
43 /** 42 /**
44 * Adds a listener 43 * Adds a listener
45 * 44 *
46 * @deprecated use FilterNotifier.on(action, callback) 45 * @deprecated use FilterNotifier.on(action, callback)
47 * @param {FilterNotifierOnListener} listener 46 * @param {FilterNotifierCatchAllListener} listener
48 */ 47 */
49 addListener(listener) 48 addListener(listener)
50 { 49 {
51 let listeners = this._listeners[CATCH_ALL]; 50 let listeners = this._listeners[CATCH_ALL];
52 if (!listeners || listeners.indexOf(listener) == -1) 51 if (!listeners || listeners.indexOf(listener) == -1)
53 this.on(CATCH_ALL, listener); 52 this.on(CATCH_ALL, listener);
54 }, 53 },
55 54
56 /** 55 /**
57 * Removes a listener that was previosly added via addListener 56 * Removes a listener that was previosly added via addListener
58 * 57 *
59 * @deprecated use FilterNotifier.off(action, callback) 58 * @deprecated use FilterNotifier.off(action, callback)
60 * @param {FilterNotifierOnListener} listener 59 * @param {FilterNotifierCatchAllListener} listener
61 */ 60 */
62 removeListener(listener) 61 removeListener(listener)
63 { 62 {
64 this.off(CATCH_ALL, listener); 63 this.off(CATCH_ALL, listener);
65 }, 64 },
66 65
67 /** 66 /**
68 * Notifies listeners about an event 67 * Notifies listeners about an event
69 * @param {string} action event code ("load", "save", "elemhideupdate", 68 * @param {string} action event code ("load", "save", "elemhideupdate",
70 * "subscription.added", "subscription.removed", 69 * "subscription.added", "subscription.removed",
71 * "subscription.disabled", "subscription.title", 70 * "subscription.disabled", "subscription.title",
72 * "subscription.lastDownload", "subscription.downloadStatus", 71 * "subscription.lastDownload", "subscription.downloadStatus",
73 * "subscription.homepage", "subscription.updated", 72 * "subscription.homepage", "subscription.updated",
74 * "filter.added", "filter.removed", "filter.moved", 73 * "filter.added", "filter.removed", "filter.moved",
75 * "filter.disabled", "filter.hitCount", "filter.lastHit") 74 * "filter.disabled", "filter.hitCount", "filter.lastHit")
76 * @param {Subscription|Filter} item item that the change applies to 75 * @param {Subscription|Filter} item item that the change applies to
77 * @param {*} param1 76 * @param {*} param1
78 * @param {*} param2 77 * @param {*} param2
79 * @param {*} param3 78 * @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?
80 * @deprecated use FilterNotifier.emit(action) 79 * @deprecated use FilterNotifier.emit(action)
81 */ 80 */
82 triggerListeners(action, item, param1, param2, param3) 81 triggerListeners(action, item, param1, param2, param3)
83 { 82 {
84 this.emit(action, item, param1, param2, param3); 83 this.emit(action, item, param1, param2, param3);
85 this.emit(CATCH_ALL, action, item, param1, param2, param3); 84 this.emit(CATCH_ALL, action, item, param1, param2, param3);
86 } 85 }
87 })); 86 }));
LEFTRIGHT

Powered by Google App Engine
This is Rietveld