https://github.com/lindell/remote-function

Make function calls to remote hosts seamlessly
https://github.com/lindell/remote-function

es6-proxies json-rpc json-rpc2 rpc

Last synced: about 2 months ago
JSON representation

Make function calls to remote hosts seamlessly

• Host: GitHub
• URL: https://github.com/lindell/remote-function
• Owner: lindell
• License: mit
• Created: 2018-01-27T21:26:20.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T02:32:58.000Z (almost 2 years ago)
• Last Synced: 2024-05-13T07:44:28.168Z (8 months ago)
• Topics: es6-proxies, json-rpc, json-rpc2, rpc
• Language: JavaScript
• Homepage:
• Size: 816 KB
• Stars: 99
• Watchers: 4
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Remote Function

[![Build Status](https://travis-ci.org/lindell/remote-function.svg?branch=master)](https://travis-ci.org/lindell/remote-function)

[![Coverage Status](https://coveralls.io/repos/github/lindell/remote-function/badge.svg?branch=master)](https://coveralls.io/github/lindell/remote-function?branch=master)

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 via [JSON RPC 2.0](http://www.jsonrpc.org/specification) which makes it possible to use with other clients. It has _no dependencies_ and works by utilizing [Proxies](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy) that was introduced with ES6.

## Install

```

npm install remote-function

```

## Example

#### Server

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

```javascript

const server = require('remote-function').createServer();

server.divide = (arg1, arg2) => {

    if (arg2 === 0) {

        throw new Error("Can't divide by zero.");

    }

    return arg1 / arg2;

};

```

#### Client

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 with `await` if you are within an `async` function.

```javascript

const remote = require('remote-function').createClient({ host: '127.0.0.1' });

const result = await remote.divide(12, 3);

console.log(result); // 4

```

If an error is thrown on the server:

```javascript

try {

    const result = await remote.divide(12, 0);

    console.log(result); // Will not be reached

} catch (error) {

    // Get the error thrown on the server, including stacktrace

}

```

## Options

#### Server

| Option         | Default     | Description                                  |

| -------------- | ----------- | -------------------------------------------- |

| `host`         | `"0.0.0.0"` | The host that the server listen on           |

| `port`         | `6356`      | The port that the server listen on           |

| `includeStack` | `true`      | Should errors include the server stacktrace? |

#### Client

| Option            | Default                     | Description                         |

| ----------------- | --------------------------- | ----------------------------------- |

| `host`            | `"127.0.0.1"` | The host that the server listens on |

| `port`            | `6356`        | The port that the server listens on |

| `headers`         | `{}`          | Additional request headers          |

| `connectTimeout`  | `0`           | The socket connection timeout       |

| `responseTimeout` | `0`           | The response wait timeout           |

`createClient` also supports options from [http.request()](https://nodejs.org/api/http.html#http_http_request_options_callback). For example, you can set `headers` to add extra headers to http request, or `auth` if you need Basic Authentication. You cannot change http request _method_.