Skip to content

Commit c1e3cc3

Browse files
authored
Add files via upload
1 parent db2404d commit c1e3cc3

4 files changed

Lines changed: 188 additions & 2 deletions

File tree

.eslintrc.json

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
{
2+
"env": {
3+
"browser": true,
4+
"es6": true,
5+
"node" : true
6+
},
7+
"extends": "eslint:recommended",
8+
"parserOptions": {
9+
"sourceType": "module",
10+
"ecmaVersion": 8
11+
},
12+
"plugins": [
13+
],
14+
"rules": {
15+
"no-useless-escape" : "off",
16+
"no-constant-condition" : "off",
17+
"no-unused-vars" : "warn",
18+
"no-console": "off",
19+
"no-mixed-spaces-and-tabs" : "warn",
20+
"indent": [
21+
"warn",
22+
4,
23+
{"SwitchCase": 1}
24+
],
25+
"linebreak-style": [
26+
"error",
27+
"unix"
28+
],
29+
"quotes": [
30+
"error",
31+
"single"
32+
],
33+
"semi": [
34+
"warn",
35+
"always",
36+
{"omitLastInOneLineBlock" : true}
37+
]
38+
}
39+
}

README.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
1-
# getEventListeners
2-
Returns an object containing all the event listeners of a DOM Node
1+
## Element.prototype.getEventListeners()
2+
3+
Returns the event listeners registered on the specified object. The return value is an object that contains an array for each registered event type (click or keydown, for example). The members of each array are objects that describe the listener registered for each type.
4+
5+
6+
7+
8+
A simple usage example :
9+
```javascript
10+
let myEl = document.getElementById('someElementId');
11+
// add some event listeners to the Element
12+
myEl.addEventListener('click', e=> console.log('click!') );
13+
myEl.addEventListener('click', e=> console.log('click 2!') );
14+
myEl.addEventListener('mouseover', e=> console.log('mouse over!') );
15+
16+
// retrieve the listeners
17+
let listeners = myEl.getEventListeners();
18+
console.log(listeners);
19+
/*
20+
Console output :
21+
{
22+
click : [
23+
{ listener: ƒ, useCapture: false},
24+
{ listener: ƒ, useCapture: false}
25+
],
26+
mouseover : [
27+
{ listener: ƒ, useCapture: false}
28+
]
29+
}
30+
*/
31+
```
32+
33+
## Limitations
34+
35+
To be able to track the event listeners assignements, this module overwrites `Element.prototype.addEventListener` and `Element.prototype.removeEventListener`, with custom functions that mantain an updated list of listeners.
36+
Any event listener declared before this module is imported will be missed.
37+
38+
> **In order to be able to track all the listeners, this module must be imported before any event listener is declared.**

package.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"name": "geteventlisteners",
3+
"description": "getEventListeners() : Returns an object containing all the event listeners of a DOM Node.",
4+
"version": "1.0.3",
5+
"main": "./src/getEventListeners.js",
6+
"keywords": [
7+
"Element.prototype.getEventListeners",
8+
"getEventListeners",
9+
"get Event Listeners",
10+
"get-event-listeners",
11+
"eventListeners",
12+
"event-listeners",
13+
"event listeners",
14+
"getElementListeners",
15+
"get Element Listeners",
16+
"get-element-listeners"
17+
],
18+
"author": "colxi",
19+
"license": "MIT",
20+
"repository": {
21+
"type": "git",
22+
"url": "https://github.com/colxi/getEventListeners/"
23+
},
24+
"dependencies": {},
25+
"devDependencies": {}
26+
}

src/getEventListeners.js

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
(function() {
2+
'use strict';
3+
4+
// todo : use a weakmap to store the references
5+
const _eventListeners = new WeakMap();
6+
7+
// save the original methods before overwriting them
8+
Element.prototype._addEventListener = Element.prototype.addEventListener;
9+
Element.prototype._removeEventListener = Element.prototype.removeEventListener;
10+
11+
12+
/**
13+
* [addEventListener description]
14+
* @param {[type]} a [description]
15+
* @param {[type]} b [description]
16+
* @param {[type]} c [description]
17+
*/
18+
Element.prototype.addEventListener = function(a,b,c) {
19+
if(c==undefined) c=false;
20+
this._addEventListener(a,b,c);
21+
22+
if(!this.eventListenerList) this.eventListenerList = {};
23+
if(!this.eventListenerList[a]) this.eventListenerList[a] = [];
24+
25+
//this.removeEventListener(a,b,c); // TODO - handle duplicates..
26+
this.eventListenerList[a].push({listener:b,useCapture:c});
27+
};
28+
29+
/**
30+
* [removeEventListener description]
31+
* @param {[type]} a [description]
32+
* @param {[type]} b [description]
33+
* @param {[type]} c [description]
34+
* @return {[type]} [description]
35+
*/
36+
Element.prototype.removeEventListener = function(a,b,c) {
37+
if(c==undefined)
38+
c=false;
39+
this._removeEventListener(a,b,c);
40+
if(!this.eventListenerList) this.eventListenerList = {};
41+
if(!this.eventListenerList[a]) this.eventListenerList[a] = [];
42+
43+
// Find the event in the list
44+
for(var i=0;i<this.eventListenerList[a].length;i++){
45+
if(this.eventListenerList[a][i].listener==b && this.eventListenerList[a][i].useCapture==c){ // Hmm..
46+
this.eventListenerList[a].splice(i, 1);
47+
break;
48+
}
49+
}
50+
51+
if(this.eventListenerList[a].length==0) delete this.eventListenerList[a];
52+
};
53+
54+
55+
/**
56+
* [getEventListeners description]
57+
* @param {[type]} a [description]
58+
* @return {[type]} [description]
59+
*/
60+
Element.prototype.getEventListeners = function(a){
61+
if(!this.eventListenerList) this.eventListenerList = {};
62+
if(a==undefined) return this.eventListenerList;
63+
return this.eventListenerList[a];
64+
};
65+
66+
67+
/*
68+
Element.prototype.clearEventListeners = function(a){
69+
if(!this.eventListenerList)
70+
this.eventListenerList = {};
71+
if(a==undefined){
72+
for(var x in (this.getEventListeners())) this.clearEventListeners(x);
73+
return;
74+
}
75+
var el = this.getEventListeners(a);
76+
if(el==undefined)
77+
return;
78+
for(var i = el.length - 1; i >= 0; --i) {
79+
var ev = el[i];
80+
this.removeEventListener(a, ev.listener, ev.useCapture);
81+
}
82+
};
83+
*/
84+
85+
})();

0 commit comments

Comments
 (0)