See full documentation in the repo: https://github.com/MikeShi42/rrequire

why rrequire?

The 🚀 fastest ⚡️ way for web apps to start talking to servers. Connect your frontend to your backend with just 3 lines of code and zero configuration.

Enjoy familiar node module export syntax and ES6 import syntax to make your remote calls.

Warning: This package is still experimental and the API may change in-between minor versions.

Getting Started

Server

The rrequire server allows for easy definition of remote functions that will be served on a Node server using the JSON-RPC protocol over http.

Install from npm:

npm install @rrequire/server

'Export' a remote function:

function add(x, y) {
  return x + y;
}

require('@rrequire/server').serve({
  add,
});

Using serve a rrequire server on port 8080 will be started with CORS enabled for any host for quick prototyping.

Stand-Alone Configuration

Call the start function before any export function calls to explicitly start the Node server with custom options. Calling start after an export will have no effect.

Calling serve alone will automatically start up a server with default options.

const rrequire = require('@rrequire/server')

// ...function definitions here

rrequire.start({ port: 3000, enableCors: true });
rrequire.export({
  // ... function exports here
});

Function Signature: export(Object functionsToExport)

Export with Options Example:

require('@rrequire/server').export({
    func1,
    func2,
});

Start Options

Key | Type | Default | Description --- | --- | --- | --- port | Number | 3000 | Port number to listen to incoming RPC requests. enableCors | Boolean | true | If true, allows RPC requests from any domain.

Connect Middleware (Use in Existing Apps)

Use rrequire in your current express/connect app by inserting the rrequire server as middleware.

const rrequire = require('@rrequire/server');
const express = require('express');

const app = express();
// ... Your express app
app.all('/rpc', rrequire.middleware({ enableCors: true }));

Middleware Options

Key | Type | Default | Description --- | --- | --- | --- end | Boolean | true | If set to false causes the middleware to next() instead of res.end() when finished. enableCors | Boolean | true | If true, allows requests from any domain.

Further Info

The server largely depends on jayson middleware to handle RPC function registration and invocation. iddleware to handle RPC function registration and invocation.