From 4d0a8207ff998eab60164d52f4e8496c7756f874 Mon Sep 17 00:00:00 2001 From: Otto Mao Date: Mon, 5 Feb 2018 10:33:31 +0800 Subject: [PATCH] update document and version --- docs-src/cn/README.md | 5 +++-- docs-src/en/README.md | 13 +++++++------ package.json | 2 +- 3 files changed, 11 insertions(+), 9 deletions(-) diff --git a/docs-src/cn/README.md b/docs-src/cn/README.md index 0cf047a..381a1b8 100644 --- a/docs-src/cn/README.md +++ b/docs-src/cn/README.md @@ -79,11 +79,11 @@ const options = { rule: require('myRuleModule'), webInterface: { enable: true, - webPort: 8002, - wsPort: 8003, + webPort: 8002 }, throttle: 10000, forceProxyHttps: false, + wsIntercept: false, // 不开启websocket代理 silent: false }; const proxyServer = new AnyProxy.ProxyServer(options); @@ -110,6 +110,7 @@ proxyServer.close(); * `forceProxyHttps` {boolean} 是否强制拦截所有的https,忽略规则模块的返回,默认`false` * `silent` {boolean} 是否屏蔽所有console输出,默认`false` * `dangerouslyIgnoreUnauthorized` {boolean} 是否忽略请求中的证书错误,默认`false` + * `wsIntercept` {boolean} 是否开启websocket代理,默认`false` * `webInterface` {object} web版界面配置 * `enable` {boolean} 是否启用web版界面,默认`false` * `webPort` {number} web版界面端口号,默认`8002` diff --git a/docs-src/en/README.md b/docs-src/en/README.md index 300feda..527c4af 100644 --- a/docs-src/en/README.md +++ b/docs-src/en/README.md @@ -78,11 +78,11 @@ const options = { rule: require('myRuleModule'), webInterface: { enable: true, - webPort: 8002, - wsPort: 8003, + webPort: 8002 }, throttle: 10000, forceProxyHttps: false, + wsIntercept: false, silent: false }; const proxyServer = new AnyProxy.ProxyServer(options); @@ -106,11 +106,12 @@ proxyServer.close(); * `port` {number} required, port number of proxy server * `rule` {object} your rule module * `throttle` {number} throttle in kb/s, unlimited for default - * `forceProxyHttps` {boolean} in force intercept all https request, false for default - * `silent` {boolean} if keep silent in console, false for default`false` - * `dangerouslyIgnoreUnauthorized` {boolean} if ignore certificate error in 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` + * `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 - * `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 * Event: `ready` * emit when proxy server is ready diff --git a/package.json b/package.json index 3eb4250..22a7745 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "anyproxy", - "version": "4.0.2", + "version": "4.0.5", "description": "A fully configurable HTTP/HTTPS proxy in Node.js", "main": "proxy.js", "bin": {