Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
grain-rpc
Advanced tools
Readme
layer a remote-procedure-call interface on top of simple messaging, using promises
You provide messaging between two endpoints, and in return you get the ability to register interfaces or functions at either endpoint, and call them from the other side.
All you need to do is:
sendMessage()
function to deliver messages to the other side.receiveMessage()
whenever a message is received.What you get is the ability to register entire interfaces (type-checked or unchecked) on either side, and call methods on those interfaces from the other side. This is particularly pleasant with typescript. For example, if you define this interface:
export interface ICalc {
add(x: number, y: number): number;
}
Then on one side you can do:
import {ICalc} from './ICalc';
import {Rpc} from 'grain-rpc';
class Calc implements ICalc {
public add(x: number, y: number): number {
return x + y;
}
}
const rpc = new Rpc({sendMessage: yourSendMessageFunction});
// ... hook up incoming messages to rpc.receiveMessage() ...
rpc.registerImpl<ICalc>("calc", new Calc());
And on the other side you can do:
import {ICalc} from './ICalc';
import {Rpc} from 'grain-rpc';
const rpc = new Rpc({sendMessage: yourSendMessageFunction});
// ... hook up incoming messages to rpc.receiveMessage() ...
rpc.getStub<ICalc>("calc");
console.log(await stub.add(4, 5)); // should print 9
Rpc library supports ts-interface-checker descriptors for the interfaces, to allow validation.
The string name used to register and use an implementation allows for the same Rpc object to be used to expose multiple interfaces, or different implementations of the same interface.
Rpc also supports a messaging interface, with postMessage()
to send arbitrary messages, and an
EventEmitter
interface for "message" events to receive them, e.g. on("message", ...)
. So if you
need to multiplex non-Rpc messages over the same channel, Rpc class does it for you.
Rpc connections can be linked together transparently using named forwarders. For example:
const frontend = new Rpc(...);
const backend = new Rpc(...);
frontend.registerForwarder("backend", backend);
frontend.getStub<ICalc>("calc@backend");
console.log(await stub.add(4, 5)); // will call calc.add(4, 5) on backend
FAQs
Typed RPC interface on top of an arbitrary communication channel
The npm package grain-rpc receives a total of 114 weekly downloads. As such, grain-rpc popularity was classified as not popular.
We found that grain-rpc demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.