Listens for an event on an instance, modifies the original event if one was defined so that it can be listened to. Original event's code is maintained.
+
Listens for an event on an instance. Preserves any original event function code, while also allowing multiple event listeners to call on the same event.
diff --git a/docs/file/src/pulse.mjs.html b/docs/file/src/pulse.mjs.html
index 0f14f42..e894bff 100644
--- a/docs/file/src/pulse.mjs.html
+++ b/docs/file/src/pulse.mjs.html
@@ -56,6 +56,7 @@
/**
* The logger module this module uses to log errors / logs
* @private
+ * @type {Object}
*/
this.logger = new Logger();
this.logger.registerType('PulseComponent-Module', this.logger.FG_BLUE);
@@ -136,7 +137,7 @@
};
/**
- * Listens for an event on an instance, modifies the original event if one was defined so that it can be listened to. Original event's code is maintained.
+ * Listens for an event on an instance. Preserves any original event function code, while also allowing multiple event listeners to call on the same event.
* @private
* @param {Object} pInstance - The instance that has the event
* @param {string} pEventName - The event name to listen for
@@ -148,7 +149,7 @@
if (typeof(originalEvent) === 'function') {
originalEvent.apply(pInstance, arguments);
}
- // Loop the event name in the tracker to see if multiple events are attached, if so we need to call each event when this event is called.
+ // Loop the event name in the tracker to see if multiple events have been registered, if so we need to call each event when this event is dispatched.
for (const listener in PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName]) {
if (typeof(PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listener]) === 'function') {
PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listener].apply(pInstance, arguments);
diff --git a/docs/index.json b/docs/index.json
index 470a093..81fe1a9 100644
--- a/docs/index.json
+++ b/docs/index.json
@@ -567,7 +567,7 @@
"__docId__": 48,
"kind": "file",
"name": "src/pulse.mjs",
- "content": "import { Logger } from './vendor/logger.min.mjs';\r\n\r\nclass PulseComponent {\r\n\t/**\r\n\t * Array that tracks events for instances\r\n\t * @private\r\n\t * @type {Array}\r\n\t */\r\n\tstatic tracker = { 'ids': [] };\r\n\t/**\r\n\t * Array of stored IDs so that multiple of the same ID cannot be claimed\r\n\t * @private\r\n\t * @type {Array}\r\n\t */\r\n\tstatic storedIDs = [];\r\n\r\n\tconstructor() {\r\n\t\t/**\r\n\t\t * The logger module this module uses to log errors / logs\r\n\t\t * @private\r\n\t\t */\r\n\t\tthis.logger = new Logger();\r\n this.logger.registerType('PulseComponent-Module', this.logger.FG_BLUE);\r\n this.logger.prefix('PulseComponent-Module').log('PulseComponent module loaded');\r\n\t}\r\n\t\r\n\t/**\r\n\t * Generates a random ID based on the specified length and ensures its uniqueness\r\n\t * within the stored IDs.\r\n\t * @private\r\n\t * @param {number} [pID = 7] - The length of the generated ID.\r\n\t * @returns {string} A unique random ID.\r\n\t */\r\n\tgenerateID(pID = 7) {\r\n\t\tconst chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';\r\n\t\tconst makeID = function() {\r\n\t\t\tlet ID = '';\r\n\t\t\tfor (let i = 0; i < pID; i++) {\r\n\t\t\t\tID += chars.charAt(Math.floor(Math.random() * chars.length));\r\n\t\t\t}\r\n\t\t\treturn ID;\r\n\t\t}\r\n\t\tlet ID = makeID();\r\n\t\twhile(PulseComponent.storedIDs.includes(ID)) {\r\n\t\t\tID = makeID();\r\n\t\t}\r\n\t\tPulseComponent.storedIDs.push(ID);\r\n\t\treturn ID;\r\n\t}\r\n\t/**\r\n\t * Adds an event listener function to pInstance to call whenever pEventName is called\r\n\t * \r\n\t * @param {Object} pInstance - The instance to add an event listener to\r\n\t * @param {string} pEventName - The name of the event to add the listener to\r\n\t * @param {Function} pFunction - The function to be called when this event is called\r\n\t */\r\n\ton(pInstance, pEventName, pFunction) {\r\n\t\tif (typeof(pFunction) !== 'function') {\r\n\t\t\tthis.logger.prefix('PulseComponent-Module').error('pFunction argument is missing or it is not of the function type!');\r\n\t\t\treturn;\r\n\t\t}\r\n\r\n\t\tif (!pInstance.pulseComponentListenerID) {\r\n\t\t\tconst ID = this.generateID();\r\n\t\t\tpInstance.pulseComponentListenerID = ID;\r\n\t\t\tPulseComponent.tracker.ids.push(ID);\r\n\t\t\tPulseComponent.tracker[pInstance.pulseComponentListenerID] = {};\r\n\t\t\tPulseComponent.tracker[pInstance.pulseComponentListenerID]['listened'] = {};\r\n\t\t}\r\n\r\n\t\tif (!PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName]) PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName] = { 'counter': 0 };\r\n\t\tconst listenerID = ++PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName].counter;\r\n\t\tif (!PulseComponent.tracker[pInstance.pulseComponentListenerID]['listened'][pEventName]) this.listenForEvent(pInstance, pEventName);\r\n\t\tPulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listenerID] = pFunction;\r\n\t\t// If the event name is `onNew` then call immedietly, there is no way to capture this event\r\n\t\tif (pEventName === 'onNew') PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listenerID].bind(pInstance)();\r\n\t};\r\n\r\n\t/**\r\n\t * Removes an event listener function from pInstance\r\n\t * \r\n\t * @param {Object} pInstance - The instance to remove the event listener from\r\n\t * @param {string} pEventName - The name of the event to remove\r\n\t * @param {Function} pFunction - The function to be removed\r\n\t */\r\n\toff(pInstance, pEventName, pFunction) {\r\n\t\tif (typeof(pFunction) !== 'function') {\r\n\t\t\tthis.logger.prefix('PulseComponent-Module').error('pFunction argument is missing or it is not of the function type!');\r\n\t\t\treturn;\r\n\t\t}\r\n\t\tfor (const listenerID in PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName]) {\r\n\t\t\tif (PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listenerID] === pFunction) {\r\n\t\t\t\tdelete PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listenerID];\r\n\t\t\t\treturn;\r\n\t\t\t}\r\n\t\t}\r\n\t\tthis.logger.prefix('PulseComponent-Module').error('This function is not being tracked.');\r\n\t};\r\n\r\n\t/**\r\n\t * Listens for an event on an instance, modifies the original event if one was defined so that it can be listened to. Original event's code is maintained.\r\n\t * @private\r\n\t * @param {Object} pInstance - The instance that has the event\r\n\t * @param {string} pEventName - The event name to listen for\r\n\t */\r\n\tlistenForEvent(pInstance, pEventName) {\r\n\t\t// If there was a valid event for this type, or there was one already defined then we need to modify it to allow listening events\r\n\t\tlet originalEvent = pInstance[pEventName];\r\n\t\tconst listener = function() {\r\n\t\t\tif (typeof(originalEvent) === 'function') {\r\n\t\t\t\toriginalEvent.apply(pInstance, arguments);\r\n\t\t\t}\r\n\t\t\t// Loop the event name in the tracker to see if multiple events are attached, if so we need to call each event when this event is called.\r\n\t\t\tfor (const listener in PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName]) {\r\n\t\t\t\tif (typeof(PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listener]) === 'function') {\r\n\t\t\t\t\tPulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listener].apply(pInstance, arguments);\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}\r\n\t\tpInstance[pEventName] = listener;\r\n\t\tPulseComponent.tracker[pInstance.pulseComponentListenerID]['listened'][pEventName] = true;\r\n\t};\r\n}\r\n\r\nexport const Pulse = new PulseComponent();\r\n",
+ "content": "import { Logger } from './vendor/logger.min.mjs';\r\n\r\nclass PulseComponent {\r\n\t/**\r\n\t * Array that tracks events for instances\r\n\t * @private\r\n\t * @type {Array}\r\n\t */\r\n\tstatic tracker = { 'ids': [] };\r\n\t/**\r\n\t * Array of stored IDs so that multiple of the same ID cannot be claimed\r\n\t * @private\r\n\t * @type {Array}\r\n\t */\r\n\tstatic storedIDs = [];\r\n\r\n\tconstructor() {\r\n\t\t/**\r\n\t\t * The logger module this module uses to log errors / logs\r\n\t\t * @private\r\n\t\t * @type {Object}\r\n\t\t */\r\n\t\tthis.logger = new Logger();\r\n this.logger.registerType('PulseComponent-Module', this.logger.FG_BLUE);\r\n this.logger.prefix('PulseComponent-Module').log('PulseComponent module loaded');\r\n\t}\r\n\t\r\n\t/**\r\n\t * Generates a random ID based on the specified length and ensures its uniqueness\r\n\t * within the stored IDs.\r\n\t * @private\r\n\t * @param {number} [pID = 7] - The length of the generated ID.\r\n\t * @returns {string} A unique random ID.\r\n\t */\r\n\tgenerateID(pID = 7) {\r\n\t\tconst chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';\r\n\t\tconst makeID = function() {\r\n\t\t\tlet ID = '';\r\n\t\t\tfor (let i = 0; i < pID; i++) {\r\n\t\t\t\tID += chars.charAt(Math.floor(Math.random() * chars.length));\r\n\t\t\t}\r\n\t\t\treturn ID;\r\n\t\t}\r\n\t\tlet ID = makeID();\r\n\t\twhile(PulseComponent.storedIDs.includes(ID)) {\r\n\t\t\tID = makeID();\r\n\t\t}\r\n\t\tPulseComponent.storedIDs.push(ID);\r\n\t\treturn ID;\r\n\t}\r\n\t/**\r\n\t * Adds an event listener function to pInstance to call whenever pEventName is called\r\n\t * \r\n\t * @param {Object} pInstance - The instance to add an event listener to\r\n\t * @param {string} pEventName - The name of the event to add the listener to\r\n\t * @param {Function} pFunction - The function to be called when this event is called\r\n\t */\r\n\ton(pInstance, pEventName, pFunction) {\r\n\t\tif (typeof(pFunction) !== 'function') {\r\n\t\t\tthis.logger.prefix('PulseComponent-Module').error('pFunction argument is missing or it is not of the function type!');\r\n\t\t\treturn;\r\n\t\t}\r\n\r\n\t\tif (!pInstance.pulseComponentListenerID) {\r\n\t\t\tconst ID = this.generateID();\r\n\t\t\tpInstance.pulseComponentListenerID = ID;\r\n\t\t\tPulseComponent.tracker.ids.push(ID);\r\n\t\t\tPulseComponent.tracker[pInstance.pulseComponentListenerID] = {};\r\n\t\t\tPulseComponent.tracker[pInstance.pulseComponentListenerID]['listened'] = {};\r\n\t\t}\r\n\r\n\t\tif (!PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName]) PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName] = { 'counter': 0 };\r\n\t\tconst listenerID = ++PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName].counter;\r\n\t\tif (!PulseComponent.tracker[pInstance.pulseComponentListenerID]['listened'][pEventName]) this.listenForEvent(pInstance, pEventName);\r\n\t\tPulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listenerID] = pFunction;\r\n\t\t// If the event name is `onNew` then call immedietly, there is no way to capture this event\r\n\t\tif (pEventName === 'onNew') PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listenerID].bind(pInstance)();\r\n\t};\r\n\r\n\t/**\r\n\t * Removes an event listener function from pInstance\r\n\t * \r\n\t * @param {Object} pInstance - The instance to remove the event listener from\r\n\t * @param {string} pEventName - The name of the event to remove\r\n\t * @param {Function} pFunction - The function to be removed\r\n\t */\r\n\toff(pInstance, pEventName, pFunction) {\r\n\t\tif (typeof(pFunction) !== 'function') {\r\n\t\t\tthis.logger.prefix('PulseComponent-Module').error('pFunction argument is missing or it is not of the function type!');\r\n\t\t\treturn;\r\n\t\t}\r\n\t\tfor (const listenerID in PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName]) {\r\n\t\t\tif (PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listenerID] === pFunction) {\r\n\t\t\t\tdelete PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listenerID];\r\n\t\t\t\treturn;\r\n\t\t\t}\r\n\t\t}\r\n\t\tthis.logger.prefix('PulseComponent-Module').error('This function is not being tracked.');\r\n\t};\r\n\r\n\t/**\r\n\t * Listens for an event on an instance. Preserves any original event function code, while also allowing multiple event listeners to call on the same event.\r\n\t * @private\r\n\t * @param {Object} pInstance - The instance that has the event\r\n\t * @param {string} pEventName - The event name to listen for\r\n\t */\r\n\tlistenForEvent(pInstance, pEventName) {\r\n\t\t// If there was a valid event for this type, or there was one already defined then we need to modify it to allow listening events\r\n\t\tlet originalEvent = pInstance[pEventName];\r\n\t\tconst listener = function() {\r\n\t\t\tif (typeof(originalEvent) === 'function') {\r\n\t\t\t\toriginalEvent.apply(pInstance, arguments);\r\n\t\t\t}\r\n\t\t\t// Loop the event name in the tracker to see if multiple events have been registered, if so we need to call each event when this event is dispatched.\r\n\t\t\tfor (const listener in PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName]) {\r\n\t\t\t\tif (typeof(PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listener]) === 'function') {\r\n\t\t\t\t\tPulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listener].apply(pInstance, arguments);\r\n\t\t\t\t}\r\n\t\t\t}\r\n\t\t}\r\n\t\tpInstance[pEventName] = listener;\r\n\t\tPulseComponent.tracker[pInstance.pulseComponentListenerID]['listened'][pEventName] = true;\r\n\t};\r\n}\r\n\r\nexport const Pulse = new PulseComponent();\r\n",
"static": true,
"longname": "C:/Users/jared/Documents/Github/Pulse/src/pulse.mjs",
"access": "public",
@@ -586,7 +586,7 @@
"importPath": "./src/pulse.mjs",
"importStyle": "{Pulse}",
"description": null,
- "lineNumber": 125,
+ "lineNumber": 126,
"undocument": true,
"type": {
"types": [
@@ -672,11 +672,14 @@
"longname": "src/pulse.mjs~PulseComponent#logger",
"access": "private",
"description": "The logger module this module uses to log errors / logs",
- "lineNumber": 22,
+ "lineNumber": 23,
"type": {
+ "nullable": null,
"types": [
- "*"
- ]
+ "Object"
+ ],
+ "spread": false,
+ "description": null
}
},
{
@@ -690,7 +693,7 @@
"longname": "src/pulse.mjs~PulseComponent#generateID",
"access": "private",
"description": "Generates a random ID based on the specified length and ensures its uniqueness\nwithin the stored IDs.",
- "lineNumber": 34,
+ "lineNumber": 35,
"unknown": [
{
"tagName": "@returns",
@@ -731,7 +734,7 @@
"longname": "src/pulse.mjs~PulseComponent#on",
"access": "public",
"description": "Adds an event listener function to pInstance to call whenever pEventName is called",
- "lineNumber": 57,
+ "lineNumber": 58,
"params": [
{
"nullable": null,
@@ -777,7 +780,7 @@
"longname": "src/pulse.mjs~PulseComponent#off",
"access": "public",
"description": "Removes an event listener function from pInstance",
- "lineNumber": 86,
+ "lineNumber": 87,
"params": [
{
"nullable": null,
@@ -822,8 +825,8 @@
"static": false,
"longname": "src/pulse.mjs~PulseComponent#listenForEvent",
"access": "private",
- "description": "Listens for an event on an instance, modifies the original event if one was defined so that it can be listened to. Original event's code is maintained.",
- "lineNumber": 106,
+ "description": "Listens for an event on an instance. Preserves any original event function code, while also allowing multiple event listeners to call on the same event.",
+ "lineNumber": 107,
"params": [
{
"nullable": null,
diff --git a/docs/source.html b/docs/source.html
index 4ed9c3f..ff54d4a 100644
--- a/docs/source.html
+++ b/docs/source.html
@@ -55,9 +55,9 @@
Pulse
PulseComponent |
- |
-
5268 byte |
-
125 |
-
2023-12-03 15:17:10 (UTC) |
+
5302 byte |
+
126 |
+
2023-12-03 23:02:02 (UTC) |
diff --git a/docs/variable/index.html b/docs/variable/index.html
index 2e079b0..b6b35b2 100644
--- a/docs/variable/index.html
+++ b/docs/variable/index.html
@@ -85,11 +85,11 @@
-
+
diff --git a/src/pulse.mjs b/src/pulse.mjs
index cb4e524..1a5a6ef 100644
--- a/src/pulse.mjs
+++ b/src/pulse.mjs
@@ -18,6 +18,7 @@ class PulseComponent {
/**
* The logger module this module uses to log errors / logs
* @private
+ * @type {Object}
*/
this.logger = new Logger();
this.logger.registerType('PulseComponent-Module', this.logger.FG_BLUE);
@@ -98,7 +99,7 @@ class PulseComponent {
};
/**
- * Listens for an event on an instance, modifies the original event if one was defined so that it can be listened to. Original event's code is maintained.
+ * Listens for an event on an instance. Preserves any original event function code, while also allowing multiple event listeners to call on the same event.
* @private
* @param {Object} pInstance - The instance that has the event
* @param {string} pEventName - The event name to listen for
@@ -110,7 +111,7 @@ class PulseComponent {
if (typeof(originalEvent) === 'function') {
originalEvent.apply(pInstance, arguments);
}
- // Loop the event name in the tracker to see if multiple events are attached, if so we need to call each event when this event is called.
+ // Loop the event name in the tracker to see if multiple events have been registered, if so we need to call each event when this event is dispatched.
for (const listener in PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName]) {
if (typeof(PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listener]) === 'function') {
PulseComponent.tracker[pInstance.pulseComponentListenerID][pEventName][listener].apply(pInstance, arguments);