https://github.com/ecwyne/hydra-plugin-rpc
Hydra-RPC Plugin for Hydra microservices library
https://github.com/ecwyne/hydra-plugin-rpc
hydra hydra-plugin microservices
Last synced: 3 months ago
JSON representation
Hydra-RPC Plugin for Hydra microservices library
- Host: GitHub
- URL: https://github.com/ecwyne/hydra-plugin-rpc
- Owner: ecwyne
- Created: 2017-04-18T23:06:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-18T17:37:52.000Z (over 8 years ago)
- Last Synced: 2024-11-16T05:49:54.170Z (11 months ago)
- Topics: hydra, hydra-plugin, microservices
- Language: JavaScript
- Homepage: https://www.hydramicroservice.com
- Size: 9.77 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hydra-plugin-RPC
Create and consume [remote procedure calls](https://en.wikipedia.org/wiki/Remote_procedure_call) in [hydra](https://github.com/flywheelsports/hydra) with ease.
## Install
```shell
$ npm i --save hydra-plugin-rpc
```
## Use
Two methods are added to the hydra instance to add or consume methods
```javascript
// hydra.methods(obj: Object);
// Object has keys of method names and values of functions.
hydra.methods({
methodName: (arg1, arg2, arg3) => arg1 + arg2; // return value or Promise
});
```
```javascript
// hydra.call(methodName: String, ...arguments) => Promise
// First argument is method name.
// Remaining arguments are sent to method (must be serializable).
// Returns a promise with the result.
hydra.call('methodName', arg1, arg2, arg3).then(...);
```
## Example
```javascript
// Service1.js
const hydra = require('hydra');
const HydraRPC = require('hydra-plugin-rpc');
const Promise = require('bluebird');
hydra.use(new HydraRPC());
hydra.init({...}).then(() => {
hydra.methods({
ping: () => 'pong',
sleepPing: delay => Promise.resolve('pong').delay(delay) // optionally return promises
});
});
```
```javascript
// Service2.js (even works on separate machines!)
const hydra = require('hydra');
const HydraRPC = require('hydra-plugin-rpc');
hydra.use(new HydraRPC());
hydra.init({...}).then(() => {
hydra.call('ping').then(result => console.log(result)); // Logs "pong"!
hydra.call('sleepPing', 1000).then(result => console.log(result)); // Result comes back after 1000 ms!
});
```