Merge pull request #2 from splatEric/master

support for whisper method on private channels

Author: CodePlato3721

README.md

@@ -133,21 +133,21 @@ wrapper.vm.$nextTick(() => {
 
 ## Client events
 
-You can use `userWhisper` to send user event. Only private channel object and presence channel object have `userWhisper`.
+You can use `whisper` to send user event. Only private channel object and presence channel object have `whisper`.
 
 > Note: If you are using `vue-test-utils`, call `$nextTick` before assertion.
 
 Example:
 ```javascript
 // private channel
-mockEcho.getPrivateChannel('meeting').userWhisper('meetingClicking', { username: username })
+mockEcho.getPrivateChannel('meeting').whisper('meetingClicking', { username: username })
 wrapper.vm.$nextTick(() => {
     expect(wrapper.find('.whisper-message').text()).toBe(`${username} is clicking the button`)
     done()
 })
 
 // presence channel
-mockEcho.getPresenceChannel('chat').userWhisper('chatClicking', { username: username })
+mockEcho.getPresenceChannel('chat').whisper('chatClicking', { username: username })
 wrapper.vm.$nextTick(() => {
     expect(wrapper.find('.whisper-message').text()).toBe(`${username} is clicking the button`)
     done()

src/index.ts

@@ -35,7 +35,7 @@ class PrivateChannel extends Channel {
         this.notificationFn = null
     }
 
-    userWhisper (eventName, event) {
+    whisper (eventName, event) {
         if (typeof this.clientEvents[`client-${eventName}`] === 'undefined') {
             console.error(`Channel didn't listen to client event: ${eventName}`)
             return