@gobark/udprpc - npm Package Compare versions

Comparing version 0.0.2 to 0.0.3

dist/code/Config.js

@@ -0,0 +0,0 @@ "use strict";

dist/code/UdpRpc.js

@@ -0,0 +0,0 @@ "use strict";

dist/code/UdpSocket.js

@@ -0,0 +0,0 @@ "use strict";

dist/tests/UdpRpcTest.js

@@ -0,0 +0,0 @@ "use strict";

dist/tests/UdpSocketRouterSimulator.js

@@ -0,0 +0,0 @@ "use strict";

dist/tests/UdpSocketRouterSimulatorTest.js

@@ -0,0 +0,0 @@ "use strict";

dist/tests/Utils.js

@@ -0,0 +0,0 @@ "use strict";

Gruntfile.js

@@ -0,0 +0,0 @@

package.json

 {
   "name": "@gobark/udprpc",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "A UDP-based JSON-RPC 2.0 library for peer-to-peer communications with support for ES6 promises",
-  "main": "dist/index.js",
+  "main": "dist/code/UdpRpc.js",
   "scripts": {
@@ -7,0 +7,0 @@ "test": "grunt test",

README.md

@@ -10,30 +10,63 @@ [![Build Status](https://travis-ci.org/perspectivus1/udprpc.svg?branch=master)](https://travis-ci.org/perspectivus1/udprpc)
 
-## Installation
+## Installation ##
 ```
-npm install
+npm install @gobark/udprpc
 ```
-## Development Environment
-The code, including tests, is written in TypeScript. The source files are located in the ```code``` folder. The tests and related files are located in the ```tests``` folder.
 
-The transpiled JavaScript code retains the above structure but resides in the ```dist``` folder.
+## Usage ##
+UdpRpc instance listens to the same port from which it executes requests.
 
-We use npm and Grunt to build the code and run tests. Mocha is our test framework.
-### Build Process
-* Linting the code
-* Transpiling code from TypeScript to JavaScript.
+### Server ###
+```
+const url = require("url");
+// import UdpRpc
+const UdpRpc = require("@gobark/udprpc").UdpRpc;
+// create a new instance of UdpRpc
+let udpRpcServer = new UdpRpc(3000);
+// start listening
+udpRpcServer.start();
+// handle incoming requests
+udpRpcServer.register((method, params, url, resolve, reject) => {
+    switch (method) {
+        case "sum": {
+            if (isNaN(params[0]) || isNaN(params[1])) {
+                reject("Parameters must be numbers");
+            } else {
+                resolve(Number(params[0]) + Number(params[1]));
+            }
+            break;
+        }
+        case "concat": {
+            resolve(`${params[0]}${params[1]}`);
+            break;
+        }
+    }
 
-Run this command to start the build process:
-```npm run build```
-### Test Process
-* Running tests
-* Checking code coverage
+    // stop server when needed
+    // udpRpcServer.stop();
+});
+```
+### Client ###
+```
+// import UdpRpc
+const UdpRpc = require("UdpRpc");
+// create a new instance of UdpRpc
+let udpRpcClient = new UdpRpc(3001);
+// start listening
+udpRpcClient.start();
+return udpRpcClient.send("sum", [ 1, 2 ], url.parse(`http://127.0.0.1:3000`)).then((response) => {
+    console.log(response); // response === 3
+}).catch((err) => {
+    console.error(err);
+}).then(() => {
+    // stop client
+    udpRpcClient.stop();
+});
+```
 
-Run these commands to execute the tests and coverage respectively: ```npm test``` and ```npm run coverage```
+## Contribution guidelines ##
+[See CONTRIBUTING.md](./CONTRIBUTING.md)
 
-This runs all the tests that reside in the ```dist/tests``` folder.
-### Contribution guidelines ###
-Never lower the code coverage thresholds specified in the Gruntfile.
-
-### Who do I talk to? ###
+## Who do I talk to? ##
 * [e-mail]
 * [e-mail]

tslint.json

@@ -0,0 +0,0 @@ {

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

72

increased by84.62%

Number of medium supply chain risk alerts

2

decreased by-50%

Worsened metrics

Total package byte prevSize

33775

decreased by-68.84%

Number of package files

29

decreased by-27.5%

Lines of code

473

decreased by-46.91%

No dependency changes