remote-functions
v1.1.5
Published
Forgot ugly REST/GraphQL APIs! Call server functions directly from browser!
Downloads
3
Maintainers
miceveReadme
Remote Functions library
Simple, but yet powerful library built for easy communication between server and client
Installation
# cd path/to/my/project (node.js backend)
npm i remote-functionsOr using yarn:
# cd path/to/my/project (node.js yarn backend)
yarn add remote-functionsUsage
On server side
index.js
let FManager = require("remote-functions");
let rf = new FManager();
let WebSocket = require("ws");
let wss = new WebSocket.Server({ port: 8080 });
wss.on("connection", async (socket) => {
let client = await rf.connectClient((d) => socket.send(d));
socket.on("close", client.disconnected);
socket.on("message", (m) => client.handleMessage(m));
await client.clientReady();
});
let crypto = require("crypto");
//module, that works only in node.js environment (database or etc, we used crypto only for example)
function getUUID(prefix, cb) {
setInterval(() => {
cb("hello!"); // we can even pass callbacks!
}, 1000);
// prefix used to show that we can pass any arguments to functions
console.log(prefix);
return prefix + "-" + crypto.randomUUID();
// if function is asynchronous, don't worry, we can work with async functions!
}
rf.addFunc(getUUID);
// we need to register our function to use it
On client side
index.html
<!DOCTYPE html>
<html>
<head>
<title>RF.js test</title>
</head>
<body>
<script src="https://cdn.jsdelivr.net/npm/remote-functions/bundle/rf.js"></script>
<script defer src="script.js"></script>
</body>
</html>script.js
(async () => {
// All functions in RF.js is asynchronous by the nature, so we wrapped our code in async function to use awaits
let ws = new WebSocket("ws://localhost:8080");
window.rf = new RF();
ws.onmessage = (message) => rf.RFMessageReceived(message.data);
ws.onopen = async () => {
//we can't send data to socket while it's connecting, so we need to wait while socket will be connected
await rf.RFPrepare((data) => ws.send(data));
let uuidFromServer = await rf.getUUID("myprefix", (text) => {
console.log(text); //we can work with callbacks!
});
//MAGIC! Calling function on server!
console.log(uuidFromServer);
// myprefix-1234-5678-9012-3459
};
})();