Merge pull request #1369 from postmanlabs/feature/add-is-event-helper

feat: add `isEvent` method in `Event` class

CHANGELOG.yaml

@@ -1,3 +1,7 @@
+unreleased:
+  new features:
+    - GH-1369 Added `isEvent` method in Event class
+
 4.4.1:
   date: 2024-07-29
   fixed bugs:

lib/collection/event.js

@@ -87,7 +87,18 @@ _.assign(Event, /** @lends Event */ {
      * @readOnly
      * @type {String}
      */
-    _postman_propertyName: 'Event'
+    _postman_propertyName: 'Event',
+
+    /**
+     * Check whether an object is an instance of {@link Event}.
+     *
+     * @param {*} obj -
+     * @returns {Boolean}
+     */
+    isEvent: function isPostmanEvent (obj) {
+        return Boolean(obj) && ((obj instanceof Event) ||
+            _.inSuperChain(obj.constructor, '_postman_propertyName', Event._postman_propertyName));
+    }
 });
 
 module.exports = {

test/unit/event.test.js

@@ -168,4 +168,27 @@ describe('Event', function () {
             expect(afterJSON.script).to.not.have.property('packages');
         });
     });
+
+    describe('isEvent', function () {
+        var rawEvent = {
+            listen: 'test',
+            id: 'my-global-script-1',
+            script: {
+                type: 'text/javascript',
+                exec: 'console.log("hello");'
+            }
+        };
+
+        it('should return true for an Event instance', function () {
+            expect(Event.isEvent(new Event(rawEvent))).to.be.true;
+        });
+
+        it('should return false for a raw Event object', function () {
+            expect(Event.isEvent(rawEvent)).to.be.false;
+        });
+
+        it('should return false when called without arguments', function () {
+            expect(Event.isEvent()).to.be.false;
+        });
+    });
 });

types/index.d.ts

@@ -1,4 +1,4 @@
-// Type definitions for postman-collection 4.4.0
+// Type definitions for postman-collection 4.4.1
 // Project: https://github.com/postmanlabs/postman-collection
 // Definitions by: PostmanLabs
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -649,6 +649,11 @@ declare module "postman-collection" {
          * The script that is to be executed when this event is triggered.
          */
         script: Script;
+        /**
+         * Check whether an object is an instance of Event.
+         * @param obj - -
+         */
+        static isEvent(obj: any): boolean;
     }
 
     export namespace FormParam {