From c8a25ce638f9ff26771c73156bf903823e323f96 Mon Sep 17 00:00:00 2001
From: stevezyyang <stevezyyang@tencent.com>
Date: Tue, 21 Jul 2020 16:34:44 +0800
Subject: [PATCH] docs: add docs for customFetch

---
 docs/config/common.md  | 17 +++++++++++++++++
 docs/config/default.md |  6 +++++-
 2 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/docs/config/common.md b/docs/config/common.md
index 6088ef4..a5ae909 100644
--- a/docs/config/common.md
+++ b/docs/config/common.md
@@ -63,6 +63,23 @@ export default {
 }
 ```
 
+## customFetch 自定义请求函数 <badge text="1.6.0+" />
+适用于内置库覆盖不到的场景下使用，这是一个函数，将会接收接口相关配置，在函数内发起请求，返回值为一个 Promise。
+
+```js
+export default {
+    customFetch: ({ url, data, method }) => {
+        // ...
+    },
+}
+```
+
+::: warning
+从优先级上来说这个参数和 `reqType` 互相替代，例如：
+1. 低优先级的 `reqType` 会被高优先级的 `customFetch` 覆盖（反之亦然）
+2. 若是 `reqType` 和 `customFetch` 在同级同时配置时，控制台发出告警，并且实际以 `customFetch` 为准。
+:::
+
 ## commonParams 公共参数
 有时对于所有接口都需要添加一个公共参数。
 
diff --git a/docs/config/default.md b/docs/config/default.md
index 8ba83d7..9189992 100644
--- a/docs/config/default.md
+++ b/docs/config/default.md
@@ -5,9 +5,10 @@
 import TuaApi from 'tua-api'
 
 new TuaApi({
-    host,
+    baseUrl, // 即原 host
     reqType,
     middleware,
+    customFetch,
     axiosOptions,
     jsonpOptions,
     defaultErrorData,
@@ -26,6 +27,9 @@ new TuaApi({
 ## middleware 中间件函数数组
 【所有】请求都会调用的中间件函数数组！适合添加一些通用逻辑，例如接口上报。
 
+## customFetch 自定义请求函数 <badge text="1.6.0+" />
+这是一个函数，将会接收接口相关配置，在函数内发起请求，返回值为一个 Promise。
+
 ## axiosOptions 透传 axios 配置参数
 【通用】的配置，会和之后的配置合并。