Git Product home page Git Product logo

jrus's Introduction

Jrus

Jrus is a server-client communication utility package, which facilitates seamless remote procedure call.

The communication protocol Jrus uses is jsonrpc 2.0.

Install

npm i jrus

Quick Start

Server side

import { JrusServer, JrusError } from 'jrus';

// create a new server instance
const server = new JrusServer();

// register a service
server.register(class Utility {
  async time() {
    return new Date();
  }
  async sayHi({ name }) {
    return { say: `hello, ${name} ` };
  }
  async wrong() {
    throw new JrusError({ code: 10056, message: 'sample error' });
  }
});

// run and listen on port 3000
server.listen(3000);

Client side

import { JrusClient } from 'jrus';

// create a client and connect http://localhost:3000
const client = new JrusClient('http://localhost:3000');

(async () => {
  // remote procedure call: Utility.time
  console.log(await client.services.Utility.time());
  // 018-03-31T15:54:37.568Z

  // remote procedure call: Utility.sayHi, with parameters { name: 'Special Name' }
  console.log(await client.services.Utility.sayHi({ name: 'Special Name' }));
  // { say: 'hello, Special Name ' }

  // remote procedure call: Utility.wrong; and cathc error thrown on the server side
  try {
    await client.services.Utility.wrong();
  } catch (e) {
    console.error('Error caught: ', e);
    // Error caught:  JrusError { code: 10056, message: 'sample error' }
  }

  // call some function nonexist: Utility.right
  try {
    await client.services.Utility.right();
  } catch (e) {
    console.error('Error caught: ', e);
    // Error caught:  JrusError { code: -32601, message: 'Method not found' }
  }
})();

TODO

jrus's People

Contributors

antenna3mt avatar

Stargazers

 avatar  avatar

Watchers

 avatar

jrus's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.