rpc-websocket - npm Package Compare versions

Comparing version 0.6.9 to 0.7.0

doc/api/rpc-socket.md

@@ -5,3 +5,3 @@
 
-#### RpcSocket(ws)
+#### RpcSocket(webSocket)
 
@@ -12,5 +12,5 @@ Constructor. Wraps a websocket object.
 
-* **object** *ws* The websocket object to wrap.
+* **object** *webSocket* The websocket object to wrap.
 
-#### send(MessageType, UserData)
+#### send(messageType, userData)
 
@@ -21,6 +21,6 @@ Sends a message through a websocket.
 
-* **string** *MessageType* The message's type.
-* **any** *UserData* The data to send.
+* **string** *messageType* The message's type.
+* **any** *userData* The data to send.
 
-#### rpc(MessageType, UserData, ReplyHandler)
+#### rpc(messageType, userData, replyHandler)
 
@@ -31,5 +31,5 @@ Makes an RPC call through a websocket.
 
-* **string** *MessageType* The message's type (=function name).
-* **any** *UserData* The data to send.
-* **function** *ReplyHandler* The reply handler to call when the response arrives from the server.
+* **string** *messageType* The message's type (=function name).
+* **any** *userData* The data to send.
+* **function** *replyHandler* The reply handler to call when the response arrives from the server.
 
@@ -36,0 +36,0 @@ #### close()

lib/rpc-socket.js

@@ -12,3 +12,3 @@ //      RPC Websocket
  * Constructor. Wraps a websocket object.
- * @param {object} ws The websocket object to wrap.
+ * @param {object} webSocket The websocket object to wrap.
  */
@@ -121,4 +121,4 @@ function RpcSocket(ws) {
  * Sends a message through a websocket.
- * @param {string} MessageType The message's type.
- * @param {any} UserData The data to send.
+ * @param {string} messageType The message's type.
+ * @param {any} userData The data to send.
  * @returns {void} nothing.
@@ -133,5 +133,5 @@ */
  * Makes an RPC call through a websocket.
- * @param {string} MessageType The message's type (=function name).
- * @param {any} UserData The data to send.
- * @param {function} ReplyHandler The reply handler to call when the response arrives from the server.
+ * @param {string} messageType The message's type (=function name).
+ * @param {any} userData The data to send.
+ * @param {function} replyHandler The reply handler to call when the response arrives from the server.
  * @returns {void} nothing.
@@ -138,0 +138,0 @@ */

package.json

 {
         "name" : "rpc-websocket",
-        "version": "0.6.9",
+        "version": "0.7.0",
         "description" : "RPC WebSocket is a wrapper for standard websockets that adds support for message types, RPC, and for before/after send/receive events.",
@@ -5,0 +5,0 @@ "author" : "Erik Poupaert <[e-mail]>",

README.md

@@ -20,5 +20,5 @@ #RPC WebSocket
 7.1\.  [Socket](#socket-1)  
-7.1.1\.  [RpcSocket(ws)](#rpcsocketws)  
-7.1.2\.  [send(MessageType, UserData)](#sendmessagetypeuserdata)  
-7.1.3\.  [rpc(MessageType, UserData, ReplyHandler)](#rpcmessagetypeuserdatareplyhandler)  
+7.1.1\.  [RpcSocket(webSocket)](#rpcsocketwebsocket)  
+7.1.2\.  [send(messageType, userData)](#sendmessagetypeuserdata)  
+7.1.3\.  [rpc(messageType, userData, replyHandler)](#rpcmessagetypeuserdatareplyhandler)  
 7.1.4\.  [close()](#close)  
@@ -427,5 +427,5 @@ 7.2\.  [Server](#server-1)
 
-<a name="rpcsocketws"></a>
+<a name="rpcsocketwebsocket"></a>
 
-#### 7.1.1\. RpcSocket(ws)
+#### 7.1.1\. RpcSocket(webSocket)
 
@@ -436,7 +436,7 @@ Constructor. Wraps a websocket object.
 
-* **object** *ws* The websocket object to wrap.
+* **object** *webSocket* The websocket object to wrap.
 
 <a name="sendmessagetypeuserdata"></a>
 
-#### 7.1.2\. send(MessageType, UserData)
+#### 7.1.2\. send(messageType, userData)
 
@@ -447,8 +447,8 @@ Sends a message through a websocket.
 
-* **string** *MessageType* The message's type.
-* **any** *UserData* The data to send.
+* **string** *messageType* The message's type.
+* **any** *userData* The data to send.
 
 <a name="rpcmessagetypeuserdatareplyhandler"></a>
 
-#### 7.1.3\. rpc(MessageType, UserData, ReplyHandler)
+#### 7.1.3\. rpc(messageType, userData, replyHandler)
 
@@ -459,5 +459,5 @@ Makes an RPC call through a websocket.
 
-* **string** *MessageType* The message's type (=function name).
-* **any** *UserData* The data to send.
-* **function** *ReplyHandler* The reply handler to call when the response arrives from the server.
+* **string** *messageType* The message's type (=function name).
+* **any** *userData* The data to send.
+* **function** *replyHandler* The reply handler to call when the response arrives from the server.
 
@@ -464,0 +464,0 @@ <a name="close"></a>

No alert changes

Improved metrics

Total package byte prevSize

167891

increased by0.04%

No dependency changes