feat(message-core): add unsubscribe

Availity · Aug 28, 2018 · dd6b5eb · dd6b5eb
1 parent 343b09d
commit dd6b5eb
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/packages/message-core/README.md b/packages/message-core/README.md
@@ -14,6 +14,10 @@ A package wrapping the postMessage function with helper functions and security c
 
 it returns a function that can be used to unsubscribe from that event
 
+### unsubscribe
+
+`avMessage.unsubscribe(eventName)` will remove all listeners for this event
+
 ### enabled
 
 if a value is passed in, sets messaging's enabled flag true/false based on value.

diff --git a/packages/message-core/src/index.js b/packages/message-core/src/index.js
@@ -61,6 +61,11 @@ class AvMessage {
     };
   }
 
+  // remove all subscribers for this event
+  unsubscribe(event) {
+    delete this.subscribers[event];
+  }
+
   onMessage(event, data) {
     if (this.subscribers[event]) {
       this.subscribers[event].forEach(fn => {

diff --git a/packages/message-core/src/tests/message.test.js b/packages/message-core/src/tests/message.test.js
@@ -69,6 +69,18 @@ describe('AvMessage', () => {
         [testEvent]: [fn2],
       });
     });
+
+    test('unsusbscribe should remove subscriptions for event', () => {
+      const event1 = ['a', 'b', 'c'];
+      const event2 = ['b', 'c', 'd'];
+      avMessage.subscribers = {
+        event1,
+        event2,
+      };
+
+      avMessage.unsubscribe('event1');
+      expect(avMessage.subscribers).toEqual({ event2 });
+    });
   });
 
   describe('getEventData()', () => {