iso-call

iso-call

Isomorphic call API or RPC as Promise for any nodejs/express application.

Installation

Server

npm install iso-call

Client

Use browserify + aliasify to bundle your application and iso-call for browser:

npm install browserify aliasify --save-dev

Add these into your package.json to enable aliasify:

  "browserify": {
    "transform": ["aliasify"]
  }

You may also use do more tricks with proper aliasify settings:

• hide api end points from users
• handle server side only logic
• handle client side only logic
• reduce bundle size

(TODO: add examples for these use case)

Usage

1. Enable Required ES Features

You should enable Promise and Object.assign() before using iso-call in your application for both server and client.

// A. BABEL way: Init ES6 environments for require()
require('babel/register')();

// B. polyfill way: auto polyfill Promise and Object.assign()
require('object.assign').shim();
require('es6-promise').polyfill();

2. Setup your API

You should setup all your API or RPC list only for server.

isocall = require('iso-call');

// Setup your API or RPC
isocall.addConfigs({
    // API as {name: endpoint} list
    yql: 'http://https://query.yahooapis.com/v1/public/yql',
    graph: 'https://graph.facebook.com/v2.3/641060562',

    // RPC as {name: function} list
    connectdb: function (params) {
        return mysqlPromise(params.host, params.port);
    }
});

3. Setup middleware

You should setup middleware for express only at server side to wrap client side iso-call.

var express = require('express');
var app = express();

isocall.setupMiddleware(app);

4. Call API or RPC!

Now you can do isomprphic RPC!!

// Works on both client and server side!
isocall.execute('rpcName', rpcParams).then(function (R) {
    // Success, R = result
}).catch(function (E) {
    // Failed , E = error
});

Or make isomorphic http request!!

// Works on both client and server side!
isocall.request('apiName', requestParams).then(function (R) {
    // Success, R = {error: ... , response: ... , body: ...}
}).catch(function (R) {
    // Failed , R = {error: ... , response: ... , body: ...}
});

Use Case: isomorphic RPC

Check our shell example to know more about isocall.execute().

Use Case: isomorphic http request

Check our YQL example to know more about isocall.request().

Use Case: deal with request by context

Checkout our Context example to know more about context based RPC which can access request by this.