Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pshihn/byproxy
A different way of thinking of web client-server RPC
https://github.com/pshihn/byproxy
javascript-proxy proxy rpc
Last synced: about 2 months ago
JSON representation
A different way of thinking of web client-server RPC
- Host: GitHub
- URL: https://github.com/pshihn/byproxy
- Owner: pshihn
- License: mit
- Created: 2019-03-21T11:44:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T16:58:11.000Z (about 2 years ago)
- Last Synced: 2024-05-01T15:56:01.423Z (8 months ago)
- Topics: javascript-proxy, proxy, rpc
- Language: TypeScript
- Homepage:
- Size: 1010 KB
- Stars: 41
- Watchers: 4
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - byproxy - A different way of thinking of web client-server RPC (TypeScript)
README
# ByProxy
ByProxy allows the client to access an object or module on the server as if it were a local object. The object's API can then be invoked directly on the client.
For example, a *calculator* server:
**On the server:**
```javascript
class Calculator {
constructor() {
this.opCount = 0;
}
add(a, b) {
this.opCount++;
return a + b;
}
subtract(a, b) {
this.opCount++;
return a - b;
}
}
// Serve an instance of Calculator via Express
byproxy.serve(app, '/calculator', new Calculator());
```
**On the client:**
```javascript
const calculator = byproxy.link('/calculator');
const sum = await calculator.add(2, 6); // 8
const diff = await calculator.subtract(6, 2); // 4
console.log(await calculator.opCount); // 2
```
## Advantages
* Tiny in size. The client lib is only 506 bytes gzipped.
* No need to configure different rest methods for each function call. It is handled automatically.
* When you want to add a new feature, just add a new method. Since the client is interacting with a *proxy* of the object on the server, no other setup is needed.
* If using types, both the server and client will have the same interfaces - avoids bugs and duplication of definitions.
## Other features
#### Proxy a whole module
```javascript
const mymod = require('my-awesome-mod');
byproxy.serve(app, '/updater', mymod);
```
### Proxy just a function
Server:
```javascript
byproxy.serve(app, '/hello', function (name) {
return 'Hello ' + name + '!';
});
```
Client:
```javascript
const hello = byproxy.link('/hello');
console.log(await hello('John')); // Hello John!
```
#### Seamlessly deal with async functions
Server:
```javascript
byproxy.serve(app, '/updater', {
async delayedUpdate() {
return new Promise(........);
}
});
```
Client:
```javascript
const result = await updater.delayedUpdate();
```
## Error handling
Since everything is a promise, the promise is rejected when the server returns and error code. The body of the response is in the error message and `error.code` will give you the status code of the rest call.
For most cases, when using `async-await`, simply catch the error
```javascript
const calculator = byproxy.link('/calculator');
try {
const x = await calculator.divide(10, 0); // div by 0 error
} catch (err) {
console.error(err);
}
```
## Setup
ByProxy is composed of two modules `byproxy-serve` for the server and `byproxy-link` for the client.
They are both available on NPM.
```
npm install --save byproxy-serve
npm install --save byproxy-link
```
*Note: ByProxy is not a rest library. It integrates with Express on the server. There is no dependency required on the client.*
## Examples
[ByProxy demo project](https://github.com/pshihn/byproxy-demo) is a simple example.
## License
[MIT License](https://github.com/pshihn/byproxy/blob/master/LICENSE) (c) [Preet Shihn](https://twitter.com/preetster)