Skip to content

Commit 69f240b

Browse files
committed
doc: update unHook & unProxy desc
1 parent c8d2a01 commit 69f240b

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,14 @@ proxy({
6565
- `proxyObject`是一个对象,包含三个可选的钩子`onRequest``onResponse``onError`,我们可以直接在这三个钩子中对请求进行预处理。
6666
- `window`:可选参数,默认情况会使用当前窗口的`window`对象,如果要拦截iframe中的请求,可以将`iframe.contentWindow` 传入,注意,只能拦截**同源**的iframe页面(不能跨域)。
6767

68-
返回值:浏览器原生的`XMLHttpRequest`
68+
返回值:
69+
`ProxyReturnObject`
70+
71+
ProxyReturnObject 是一个对象,包含了 `unProxy``originXhr`
72+
- `unProxy([window])`:取消拦截;取消后 `XMLHttpRequest` 将不会再被代理,浏览器原生`XMLHttpRequest`会恢复到全局变量空间
73+
- `originXhr`: 浏览器原生的 `XMLHttpRequest`
6974

70-
#### `unProxy([window])`
7175

72-
- 取消拦截;取消后`XMLHttpRequest`将不会再被代理,浏览器原生`XMLHttpRequest`会恢复到全局变量空间。
7376

7477
### 钩子函数的签名
7578

@@ -86,7 +89,7 @@ proxy({
8689
#### 示例
8790

8891
```javascript
89-
const { unProxy, originXhr } proxy({
92+
const { unProxy, originXhr } = proxy({
9093
onRequest: (config, handler) => {
9194
if (config.url === 'https://aa/') {
9295
handler.resolve({
@@ -158,11 +161,13 @@ Ajax-hook在1.x版本中只提供了一个核心拦截功能的库,在1.x中
158161
- `hooks`:钩子对象,里面是XMLHttpRequest对象的回调、方法、属性的钩子函数,钩子函数会在执行`XMLHttpRequest`对象真正的回调、方法、属性访问器前执行。
159162
- `window`:可选参数,默认情况会使用当前窗口的`window`对象,如果要拦截iframe中的请求,可以将`iframe.contentWindow` 传入,注意,只能拦截**同源**的iframe页面(不能跨域)。
160163

161-
返回值: 浏览器原生的`XMLHttpRequest`
164+
返回值:
165+
`HookReturnObject`
162166

163-
### `unHook([window])`
167+
HookReturnObject 是一个对象,包含了 `unHook``originXhr`
168+
- `unHook([window])`:取消拦截;取消后 `XMLHttpRequest` 将不会再被代理,浏览器原生`XMLHttpRequest` 会恢复到全局变量空间
169+
- `originXhr`: 浏览器原生的 `XMLHttpRequest`
164170

165-
- 取消拦截;取消后`XMLHttpRequest`将不会再被代理,浏览器原生`XMLHttpRequest`会恢复到全局变量空间
166171

167172
#### 示例
168173

0 commit comments

Comments
 (0)