Skip to content

Commit 4d0a820

Browse files
committed
update document and version
1 parent 7aadb44 commit 4d0a820

File tree

3 files changed

+11
-9
lines changed

3 files changed

+11
-9
lines changed

docs-src/cn/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,11 +79,11 @@ const options = {
7979
rule: require('myRuleModule'),
8080
webInterface: {
8181
enable: true,
82-
webPort: 8002,
83-
wsPort: 8003,
82+
webPort: 8002
8483
},
8584
throttle: 10000,
8685
forceProxyHttps: false,
86+
wsIntercept: false, // 不开启websocket代理
8787
silent: false
8888
};
8989
const proxyServer = new AnyProxy.ProxyServer(options);
@@ -110,6 +110,7 @@ proxyServer.close();
110110
* `forceProxyHttps` {boolean} 是否强制拦截所有的https,忽略规则模块的返回,默认`false`
111111
* `silent` {boolean} 是否屏蔽所有console输出,默认`false`
112112
* `dangerouslyIgnoreUnauthorized` {boolean} 是否忽略请求中的证书错误,默认`false`
113+
* `wsIntercept` {boolean} 是否开启websocket代理,默认`false`
113114
* `webInterface` {object} web版界面配置
114115
* `enable` {boolean} 是否启用web版界面,默认`false`
115116
* `webPort` {number} web版界面端口号,默认`8002`

docs-src/en/README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,11 +78,11 @@ const options = {
7878
rule: require('myRuleModule'),
7979
webInterface: {
8080
enable: true,
81-
webPort: 8002,
82-
wsPort: 8003,
81+
webPort: 8002
8382
},
8483
throttle: 10000,
8584
forceProxyHttps: false,
85+
wsIntercept: false,
8686
silent: false
8787
};
8888
const proxyServer = new AnyProxy.ProxyServer(options);
@@ -106,11 +106,12 @@ proxyServer.close();
106106
* `port` {number} required, port number of proxy server
107107
* `rule` {object} your rule module
108108
* `throttle` {number} throttle in kb/s, unlimited for default
109-
* `forceProxyHttps` {boolean} in force intercept all https request, false for default
110-
* `silent` {boolean} if keep silent in console, false for default`false`
111-
* `dangerouslyIgnoreUnauthorized` {boolean} if ignore certificate error in request, false for default
109+
* `forceProxyHttps` {boolean} in force intercept all https request, default to `false`
110+
* `silent` {boolean} if keep silent in console, false for default `false`
111+
* `dangerouslyIgnoreUnauthorized` {boolean} if ignore certificate error in request, default to `false`
112+
* `wsIntercept` {boolean} whether to intercept websocket, default to `false`
112113
* `webInterface` {object} config for web interface
113-
* `enable` {boolean} if enable web interface, false for default
114+
* `enable` {boolean} if enable web interface, default to `false`
114115
* `webPort` {number} port number for web interface
115116
* Event: `ready`
116117
* emit when proxy server is ready

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "anyproxy",
3-
"version": "4.0.2",
3+
"version": "4.0.5",
44
"description": "A fully configurable HTTP/HTTPS proxy in Node.js",
55
"main": "proxy.js",
66
"bin": {

0 commit comments

Comments
 (0)