0.1.1 • Published 7 years ago

request-proxy-middleware v0.1.1

Weekly downloads
4
License
MIT
Repository
github
Last release
7 years ago

request-proxy

Simplify usage and proxy for request.js

Travis branch GitHub issues npm

Install

npm install request-proxy -S

Usage(es6 with babel)

const proxy = require("request-proxy");
const api="http://myapi.com/getinfo";
const params = {
	params: {},
	method: 'GET',
	json: true
};
const callErrorback =function(data,error){}

exports.getInfo =function(req,res){

	proxy.send(req,api,(data,success)=>{
		if(!success){
			return res.send(proxy.renderErrSend(data.msg))
		}else{
			return res.send(proxy.renderSend(data));
		}
	},params,callErrorback);
}

Options

optiontypedefaultRequired
apiStringhttp://myapi.com/getinfoYes
paramsObject{}No
callErrorbackFunctionNo

Params-declaration

There are six kinds of params for the params

  • params

    PropertyTypeRequiredDefaultDescription
    paramsObjectNo{}
    methodStringNo'GET'one of 'GET', 'POST', 'PUT', 'DELETE'
    jsonbooleanNofalserequest params is or not json
    base64booleanNofalserequest params is or not base64
    datatypebooleanNo''
    paramsNamebooleanNo'data'request params`s name

e.g.

const params={
	params:{
		id: '110',
		accid: '3005'
	},
	method: 'GET',
	json: true,
	base64: true,
	datatype: 'json',
	paramsName: 'data'
}

Exports

  • proxy.send

  • proxy.renderSend

//usage:
  • proxy.renderErrSend

Return

A plain Object like this :

{
  msg: "",
  success: true,
  errorCode: "",
  data:{
  // xxx
  }
}
// or
{
  msg: "accid is wrong",
  success: false,
  errorCode: "30001",
  data:{}
}

Example

Please see Example.

License

The MIT License