async-call-rpc - npm Package Compare versions

Comparing version 3.1.0 to 3.2.0

CHANGELOG.md

@@ -5,2 +5,9 @@ # Changelog
 
+## [3.2.0](https://github.com/Jack-Works/async-call/compare/v3.1.0...v3.2.0) (2020-06-27)
+
+
+### Features
+
+* start to provide builtin message channels ([d97381d](https://github.com/Jack-Works/async-call/commit/d97381d03a38b16dddfe8fbbf465af7443e43f1f))
+
 ## [3.1.0](https://github.com/Jack-Works/async-call/compare/v3.0.0...v3.1.0) (2020-06-27)
@@ -7,0 +14,0 @@

package.json

 {
   "name": "async-call-rpc",
-  "version": "3.1.0",
+  "version": "3.2.0",
   "description": "A lightweight JSON RPC server & client",
@@ -20,3 +20,4 @@ "main": "out/base.js",
       "import": "./out/base.mjs"
-    }
+    },
+    "./utils/": "./utils/"
   },
@@ -23,0 +24,0 @@ "scripts": {

README.md

@@ -21,3 +21,4 @@ # Async Call
 -   [Entries](#entries)
--   [Look this if both server and client are created by this library](#look-this-if-both-server-and-client-are-created-by-this-library)
+-   [Utils available if both server and client are created by this library](#utils-available-if-both-server-and-client-are-created-by-this-library)
+-   [Builtin `messageChannels` (including WebSocket)](#builtin-messageChannels)
 -   [Implemented JSON RPC internal methods](#implemented-json-rpc-internal-methods)
@@ -181,4 +182,32 @@ -   [Non-standard extension to JSON RPC specification](#non-standard-extension-to-json-rpc-specification)
 
-## Look this if both server and client are created by this library
+## Builtin messageChannels
 
+They're not part of the core library but provided as utils to increase usability.
+
+### WebSocket Server: Node
+
+Entry point: [`async-call-rpc/utils/node/websocket.server.js`](https://github.com/Jack-Works/async-call-rpc/blob/master/utils-src/node/websocket.server.ts).
+
+Dependencies: [ws](https://npmjs.com/ws)
+
+Example: [./examples/node.websocket.server.js](https://github.com/Jack-Works/async-call-rpc/blob/master/examples/node.websocket.server.js)
+
+### WebSocket Server: Node
+
+Entry point: [`https://cdn.jsdelivr.net/npm/async-call-rpc@3.1.0/utils/deno/websocket.server.ts`](https://github.com/Jack-Works/async-call-rpc/blob/master/utils-src/deno/websocket.server.ts)
+
+Example: [./examples/deno.websocket.server.js](https://github.com/Jack-Works/async-call-rpc/blob/master/examples/deno.websocket.server.ts)
+
+### WebSocket Client: Web
+
+Entry point: [`https://cdn.jsdelivr.net/npm/async-call-rpc@3.1.0/utils/web/websocket.client.js`](https://github.com/Jack-Works/async-call-rpc/blob/master/utils-src/web/websocket.client.ts)
+
+Example: [./examples/browser.websocket.client.js](https://github.com/Jack-Works/async-call-rpc/blob/master/examples/browser.websocket.client.js)
+
+### [BroadcastChannel](https://mdn.io/BroadcastChannel) Server & Client: Web
+
+Entry point: [`https://cdn.jsdelivr.net/npm/async-call-rpc@3.1.0/utils/web/broadcast.channel.js`](https://github.com/Jack-Works/async-call-rpc/blob/master/utils-src/web/broadcast.channel.ts)
+
+## Utils available if both server and client are created by this library
+
 AsyncCall has some non-standard extensions to the JSON RPC specification that can help the library easier to use. Those features aren't enabled by default.
@@ -185,0 +214,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

333891

increased by0.56%

Number of lines in readme file

289

increased by11.15%

No dependency changes