0.2.2 • Published 7 years ago
rexxar-client v0.2.2
rexxar-cli
This is a web client of rexxar framework.
Installation
NPM
$ npm install rexxar-cli --save-dev
Example
Call UI Widget
import RexxarClient from 'rexxar-cli';
/**
* call app native ui method
* @param {string} methodName ui method name(require)
* @param {object} params ui params
* @return
*/
RexxarClient.callUI(methodName, params);
Call API
import RexxarClient from 'rexxar-cli';
/**
* call app native api method
* @param {string} apiMethodName api method name(require)
* @param {object} params params
* @param {function} successCallback success call back
* @param {function} failedCallBack failed call back
* @return
*/
RexxarClient.getAPI(methodName, params, successCallback, failedCallBack);
Call Http
import RexxarClient from 'rexxar-cli';
/**
* call Asynchronous data from http server
* @param {object} options
* @return
*/
RexxarClient.callHttp(options);
options
Parameter | Type | Description |
---|---|---|
url | string | URL to which the request is sent |
method | string | HTTP method (e.g. GET, POST, ...) |
body | Object | Data to be sent as the request body |
success | Function | success call back function |
error | Function | error call back function |
otherOptions | Object | other options |
otherOptions
Parameter | Type | Description |
---|---|---|
headers | Object | Headers object to be sent as HTTP request headers |
params | Object | Parameters object to be sent as URL parameters |
timeout | number | Request timeout in milliseconds (0 means no timeout) |
before | function(request) | Callback function to modify the request options before it is sent |
progress | function(event) | Callback function to handle the ProgressEvent of uploads |
credentials | boolean | Indicates whether or not cross-site Access-Control requests should be made using credentials |
emulateHTTP | boolean | Send PUT, PATCH and DELETE requests with a HTTP POST and set the X-HTTP-Method-Override header |
emulateJSON | boolean | Send request body as application/x-www-form-urlencoded content type |