update document and version

This commit is contained in:
Otto Mao 2018-02-05 10:33:31 +08:00
parent 7aadb44cc9
commit 4d0a8207ff
3 changed files with 11 additions and 9 deletions

View File

@ -79,11 +79,11 @@ const options = {
rule: require('myRuleModule'), rule: require('myRuleModule'),
webInterface: { webInterface: {
enable: true, enable: true,
webPort: 8002, webPort: 8002
wsPort: 8003,
}, },
throttle: 10000, throttle: 10000,
forceProxyHttps: false, forceProxyHttps: false,
wsIntercept: false, // 不开启websocket代理
silent: false silent: false
}; };
const proxyServer = new AnyProxy.ProxyServer(options); const proxyServer = new AnyProxy.ProxyServer(options);
@ -110,6 +110,7 @@ proxyServer.close();
* `forceProxyHttps` {boolean} 是否强制拦截所有的https忽略规则模块的返回默认`false` * `forceProxyHttps` {boolean} 是否强制拦截所有的https忽略规则模块的返回默认`false`
* `silent` {boolean} 是否屏蔽所有console输出默认`false` * `silent` {boolean} 是否屏蔽所有console输出默认`false`
* `dangerouslyIgnoreUnauthorized` {boolean} 是否忽略请求中的证书错误,默认`false` * `dangerouslyIgnoreUnauthorized` {boolean} 是否忽略请求中的证书错误,默认`false`
* `wsIntercept` {boolean} 是否开启websocket代理默认`false`
* `webInterface` {object} web版界面配置 * `webInterface` {object} web版界面配置
* `enable` {boolean} 是否启用web版界面默认`false` * `enable` {boolean} 是否启用web版界面默认`false`
* `webPort` {number} web版界面端口号默认`8002` * `webPort` {number} web版界面端口号默认`8002`

View File

@ -78,11 +78,11 @@ const options = {
rule: require('myRuleModule'), rule: require('myRuleModule'),
webInterface: { webInterface: {
enable: true, enable: true,
webPort: 8002, webPort: 8002
wsPort: 8003,
}, },
throttle: 10000, throttle: 10000,
forceProxyHttps: false, forceProxyHttps: false,
wsIntercept: false,
silent: false silent: false
}; };
const proxyServer = new AnyProxy.ProxyServer(options); const proxyServer = new AnyProxy.ProxyServer(options);
@ -106,11 +106,12 @@ proxyServer.close();
* `port` {number} required, port number of proxy server * `port` {number} required, port number of proxy server
* `rule` {object} your rule module * `rule` {object} your rule module
* `throttle` {number} throttle in kb/s, unlimited for default * `throttle` {number} throttle in kb/s, unlimited for default
* `forceProxyHttps` {boolean} in force intercept all https request, false for default * `forceProxyHttps` {boolean} in force intercept all https request, default to `false`
* `silent` {boolean} if keep silent in console, false for default `false` * `silent` {boolean} if keep silent in console, false for default `false`
* `dangerouslyIgnoreUnauthorized` {boolean} if ignore certificate error in request, false for default * `dangerouslyIgnoreUnauthorized` {boolean} if ignore certificate error in request, default to `false`
* `wsIntercept` {boolean} whether to intercept websocket, default to `false`
* `webInterface` {object} config for web interface * `webInterface` {object} config for web interface
* `enable` {boolean} if enable web interface, false for default * `enable` {boolean} if enable web interface, default to `false`
* `webPort` {number} port number for web interface * `webPort` {number} port number for web interface
* Event: `ready` * Event: `ready`
* emit when proxy server is ready * emit when proxy server is ready

View File

@ -1,6 +1,6 @@
{ {
"name": "anyproxy", "name": "anyproxy",
"version": "4.0.2", "version": "4.0.5",
"description": "A fully configurable HTTP/HTTPS proxy in Node.js", "description": "A fully configurable HTTP/HTTPS proxy in Node.js",
"main": "proxy.js", "main": "proxy.js",
"bin": { "bin": {