Repository files navigation

Remote Function is a library for making remote procedure calls in an intuitive way. Just declare functions on the server and call them from the client, that's it! If the function errors, the error will seamlessly be transferred to the calling client. This is done viaJSON RPC 2.0 which makes it possible to use with other clients. It hasno dependencies and works by utilizingProxies that was introduced with ES6.

npm install remote-function

Initiate a server, then just define your function on the server object.

constserver=require('remote-function').createServer();server.divide=(arg1,arg2)=>{if(arg2===0){thrownewError("Can't divide by zero.");}returnarg1/arg2;};

Define where the server is located when creating a client. Then you can just call the function that is defined at the server and you get a promise that returns what the server function will return. If you are on>=Node 8.0.0, you can use it withawait if you are within anasync function.

constremote=require('remote-function').createClient({host:'127.0.0.1'});constresult=awaitremote.divide(12,3);console.log(result);// 4

If an error is thrown on the server:

try{constresult=awaitremote.divide(12,0);console.log(result);// Will not be reached}catch(error){// Get the error thrown on the server, including stacktrace}

createClient also supports options fromhttp.request(). For example, you can setheaders to add extra headers to http request, orauth if you need Basic Authentication. You cannot change http requestmethod.