Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/webix-hub/webix-remote-js
Simple RPC for NodeJS and Webix UI
https://github.com/webix-hub/webix-remote-js
Last synced: about 1 month ago
JSON representation
Simple RPC for NodeJS and Webix UI
- Host: GitHub
- URL: https://github.com/webix-hub/webix-remote-js
- Owner: webix-hub
- Created: 2016-03-29T06:21:50.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2018-06-14T16:45:18.000Z (over 6 years ago)
- Last Synced: 2024-09-08T10:46:14.109Z (4 months ago)
- Language: JavaScript
- Homepage: http://webix.com
- Size: 21.5 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Webix Remote - Nodejs
---------------------
[](https://travis-ci.org/webix-hub/webix-remote-js)
[](https://badge.fury.io/js/webix-remote)
[](https://gitter.im/webix-hub/webix)
Simple RPC for NodeJS and Webix UI
### How to install
```
npm install webix-remote
```
### How to use
#### On server side
```js
var remote = require("webix-remote");
var api = remote.server();
api.setMethod("add", function(a,b){
return a+b;
});
api.setMethod("helpers", {
add: (a,b) => a+b,
mul: (a,b) => a*b
});
express.use("/api", api.express());
```
#### On client side
```html
webix.remote.sum(1,2).then(result){
console.log(result);
});
//or in the sync way
var sum = webix.remote.sum(1,2).sync();
```
#### Special parameters
- $req - request object
```js
api.setMethod("add", function(a,b,$req){
return a+b+$req.session.userBonus;
});
//on client - webix.remote.add(1,2);
```
#### Adding static data
You can define some static data which will be available on client side. It is a good place for session data, which need to be shared with a client-side code.
Warning - the data generation method will be called only once, during the api initialization.
```js
//server
api.setData("$user", function($req){
return $req.user.id;
});
//client
var user = webix.remote.$user;
```
#### API access levels
You can limit api to user's with defined access level.
```js
//only user with 'admin' role will be able to call the method
api.setMethod("admin@add", function(a,b){
return a+b;
});
```
Access level is defined in next way
- all methods withouth access modificator is allowed by default
- if req.session.user exists, methods with "user" modificator is allowed
- if req.session.user.role exists, methods with role modification is allowed
```js
//req.session = { user: { role:"admin,levelB"}}
api.setMethod("user@add1", (a,b) => a+b ); //allowed
api.setMethod("admin@add2", (a,b) => a+b ); //allowed
api.setMethod("levelC@add3", (a,b) => a+b ); //blocked
```
You can define your custom logic though
```js
api.$access = function(){
return {
user : !!req.user,
admin: req.user && req.user.id == 1
};
};
```
### License
MIT