Merge pull request #3 from pdroll/update-covjs

Update covjs dependency

README.md

@@ -126,6 +126,31 @@ winEvents.off('scroll.down', firstListener);
 // the second listener will continue to work.
 ```
 
+### `winEvents.off(eventName, functionReference)`
+
+You can also unsubscribe a listener from an event by passing in the same function
+that passed into the call to `on` or `once`
+
+```javascript
+var myCallback = function(scrollData) {
+  console.log('We are scrolling down the page');
+}
+
+var mySecondCallback = function(scrollData) {
+  console.log('A second listener for scrolling down');
+}
+
+winEvents.on('scroll.down', myCallback);
+winEvents.on('scroll.down', mySecondCallback);
+
+// Unsubscribe just the first Listener
+winEvents.off('scroll.down', myCallback);
+
+// myCallback no longer fire
+// when the window is scrolled down, but
+// mySecondCallback will continue to work.
+```
+
 ### `winEvents.getState()`
 
 Immediately get current size, scroll position, and visibility of the window. Returns an object with the following properties:

jest.setup.js

@@ -16,7 +16,6 @@ global.window.resizeTo = (width, height) => {
   global.window.dispatchEvent(resizeEvent)
 }
 
-
 global.beforeEach(() => {
   jest.clearAllMocks();
   jest.useFakeTimers();
@@ -39,3 +38,8 @@ global.beforeEach(() => {
     writable: true, value: 'loading'
   })
 })
+
+
+global.afterEach(() => {
+  jest.runAllTimers();
+})

package.json

@@ -1,6 +1,6 @@
 {
   "name": "windowevents",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Simple wrapper around common window events",
   "main": "windowevents.min.js",
   "license": "MIT",
@@ -13,8 +13,8 @@
     "lint": "standard src test",
     "start": "rollup -c -w",
     "build": "rollup -c",
-    "test": "jest test --coverage --verbose",
-    "test:watch": "jest test --watch"
+    "test": "jest --coverage --verbose",
+    "test:watch": "jest --watch"
   },
   "browserslist": [
     "> 0.5%",
@@ -23,7 +23,7 @@
     "IE 10"
   ],
   "dependencies": {
-    "covjs": "^1.2.0",
+    "covjs": "^2.0.1",
     "throttle-debounce": "^1.0.1"
   },
   "devDependencies": {

src/index.js

@@ -3,7 +3,7 @@
  * @author Pete Droll <[email protected]>
  * @license MIT
  */
-import publisher from 'covjs'
+import { Covenant } from 'covjs'
 import debounce from 'throttle-debounce/debounce'
 import throttle from 'throttle-debounce/throttle'
 import ScrollEvents from './scroll'
@@ -19,6 +19,8 @@ class WindowEvents {
     }
 
     this.options = opts ? { ...defaultOptions, ...opts } : defaultOptions
+
+    const publisher = new Covenant()
     this.on = publisher.on
     this.once = publisher.once
     this.off = publisher.off

test/resize-events.test.js

@@ -103,8 +103,10 @@ describe('Resize events', () => {
 
     winEvents.on('resize.scrollHeightChange', callback)
 
-    document.body.scrollHeight = 2500
+    window.resizeTo(720, 480)
     window.resizeTo(320, 480)
+    document.body.scrollHeight = 2500
+
     jest.runAllTimers()
     expect(callback).toHaveBeenCalledWith({
       orientation: 'portrait',

test/scroll-events.test.js

@@ -33,10 +33,10 @@ describe('Scroll events', () => {
         window.scrollTo(0, 200)
         window.scrollTo(0, 311)
 
-        jest.advanceTimersByTime(99)
+        jest.advanceTimersByTime(90)
         expect(callback).toHaveBeenCalledTimes(1)
 
-        jest.advanceTimersByTime(2)
+        jest.advanceTimersByTime(12)
         expect(callback).toHaveBeenCalledTimes(2)
       })
     })

test/windowevents.test.js

@@ -36,7 +36,7 @@ describe('WindowEvents', () => {
   })
 
   describe('#off', () => {
-    it('removes a previously added event listener', () => {
+    it('removes a previously added event listener by token', () => {
       const winEvents = new WindowEvents()
       const callback = jest.fn()
       const callback2 = jest.fn()
@@ -58,8 +58,30 @@ describe('WindowEvents', () => {
       expect(callback2).toHaveBeenCalledWith({ visible: true })
     })
 
+    it('removes a previously added event listener by function reference', () => {
+      const winEvents = new WindowEvents()
+      const callback = jest.fn()
+      const callback2 = jest.fn()
+
+      winEvents.on('visibilityChange', callback)
+      winEvents.on('visibilityChange', callback2)
+
+      document.hidden = true
+      window.dispatchEvent(new Event('visibilitychange'))
+
+      expect(callback).toHaveBeenCalledWith({ visible: false })
+
+      winEvents.off('visibilityChange', callback2)
+
+      document.hidden = false
+      window.dispatchEvent(new Event('visibilitychange'))
+
+      expect(callback).toHaveBeenCalledWith({ visible: true })
+      expect(callback2).not.toHaveBeenCalledWith({ visible: true })
+    })
+
     describe('when a listener is not specified', () => {
-      it('removes all previously added event listener', () => {
+      it('removes all previously added event listeners', () => {
         const winEvents = new WindowEvents()
         const callback = jest.fn()
         const callback2 = jest.fn()
@@ -79,6 +101,9 @@ describe('WindowEvents', () => {
 
         expect(callback).not.toHaveBeenCalledWith({ visible: true })
         expect(callback2).not.toHaveBeenCalledWith({ visible: true })
+
+        expect(callback).toBeCalledTimes(1)
+        expect(callback2).toBeCalledTimes(1)
       })
     })
   })