@seayoo-web/request 1.2.2 → 1.3.1

package/README.md

@@ -5,7 +5,7 @@
 市面上流行的网络请求工具有以下一些限制或不足：
 
 1. 体积过大
-2. 流行的几个 request 工具均不支持重试配置
+2. 流行的几个 request 工具均不默认支持重试配置
 3. 对响应结果不进行更多检查（无类型守卫，无结构分析），无法完美对接 ts 代码
 4. 功能过于冗余，而相当多特性实际开发中使用不到
 
@@ -48,6 +48,8 @@ export async function getUserList(): Promise<IUser[]> {
 import { setGlobalConfig } from "@seayoo-web/request"
 // nodejs 环境
 import { setGlobalConfig } from "@seayoo-web/request/node"
+// 或在某些编译配置或编辑器中无法识别上述路径，可以改用实际的 dist 路径导入
+import { setGlobalConfig } from "@seayoo-web/request/dist/node"
 
 // 以下是默认的全局配置（更多介绍请参考下方全局配置）
 setGlobalConfig({
@@ -147,7 +149,7 @@ setConfig({ timeout: 5000 })
 
 说明：用于指定如何解析响应体内容
 
-- **FailedRule**: {  resolve, messageField? }
+- **FailedRule**: {  resolve, statusField?, messageField? }
 
   http失败时 (status <200 || status >= 400) 解析策略
 
@@ -155,6 +157,10 @@ setConfig({ timeout: 5000 })
 
   ​	解析方式，设置为 json（默认），则可以进一步指定错误消息字段；设置为 body 则将整个 body 解析为错误信息；
 
+  **statusField**: string
+
+  ​	解析错误消息的状态字段，仅在 resolve 为 json 时有效，有值的话会替换 response 的 code
+
   **messageField**: string | string[]
 
   ​	错误消息解析字段，仅在 resolve 为 json 时有效，默认值 "message"
@@ -169,15 +175,15 @@ setConfig({ timeout: 5000 })
 
   **statusField**: string
   
-   指定表示自定义状态的字段名，默认是 "code"
+  ​	指定表示自定义状态的字段名，默认是 "code"
 
   **statusOKValue**: string
 
   ​	指定表示自定义状态成功时的 value，默认是 "0"，如果响应值为数字，则会被转化为字符串进行处理
 
-  **dataField**: string
+  **dataField**: string | true
 
-  ​	指定表示响应数据的字段，默认是 "data"
+  ​	指定表示响应数据的字段，默认是 "data"，如果设置为 true，则将整个 json body 作为数据内容返回
 
   **messageField**: string | string[]
 
@@ -191,29 +197,47 @@ setConfig({ timeout: 5000 })
 
 类型：number
 
-说明：当请求发生错误时重试的次数，默认0，最大为 10
+说明：当请求发生错误时重试的次数，默认0，即不重试，最大为 10
 
 ### retryResolve
 
-类型："network" | "status"
+类型："network" | "status" | number[] | ((result: IRequestBaseResponse, count: number) => boolean)
+
+说明：重试判断方法，默认是 network
+
+network 表示仅仅当网络错误时才重试；
 
-说明：重试判断方法，network 表示仅仅当网络错误时才重试；status 表示网络错误或者状态码错误时重试； 默认是 network
+status 表示网络错误或者http 状态码错误时重试；
+
+当设置为 number[] 时，将检查 http 状态码，匹配则重试；
+
+也可以设置为一个重试检查函数，返回 true 则进行重试；
 
 ### retryInterval
 
-类型：number | ((retryIndex: number) => number)
+类型：number | "2EB" | ((retryIndex: number) => number)
+
+说明：两次重试的间隔策略，设置为数字（单位 ms）表示固定间隔，设置为函数则可以自定义间隔；
+
+其中 retryIndex 从 1 开始，最大为 10；最小时间间隔为 100ms；
 
-说明：两次重试的间隔策略，设置为数字（单位 ms）表示固定间隔，设置为函数则可以自定义间隔；其中 retryIndex 从 1 开始，最大为 10；最小时间间隔为 100ms；
+特殊值 2EB 表示以 2 为底的[指数退避策略](https://en.wikipedia.org/wiki/Exponential_backoff)，即首次重试等待 1 秒，后续分别是 2秒，4秒，8秒 ...
 
-### requestHandler
+### requestTransformer
 
-类型：null | ((headers: Record<string, string>, params: Record<string, string>, method: string, url: string) => MaybePromise<void | string>)
+类型：null | ((data: {
+		headers: Record<string, string>,
+		params: Record<string, string>,
+		method: string,
+		url: string,
+		body: IBaseRequestBody
+	}) => MaybePromise<void | string>)
 
-说明：同时兼具 transformer 的功能，可用于发送前修改请求相关数据
+说明：可用于发送前修改请求相关数据，通常用于追加认证信息或签名信息
 
 - 发送前用于修改 headers 或 params 的函数，headers 和 params 为引用数据，可以直接修改或追加内容；
 - 函数如果返回一个非空字符串，则当作 url 地址使用，原有的 url 地址将被替换；
-- 通常用于全局追加 header 自定义认证信息；
+- 通常用于全局追加 header 自定义认证信息或签名信息；
 
 ### errorHandler
 
@@ -237,7 +261,7 @@ setConfig({ timeout: 5000 })
 
 类型：null | ((data: IRequestLog) => void)
 
-说明：全局日志打印函数，目前仅仅输出请求开始和完成的日志，具体日志信息可参考 types 声明；
+说明：全局日志打印函数，具体日志信息可参考源码类型声明；
 
 ## 网络请求参数
 
@@ -285,11 +309,11 @@ setConfig({ timeout: 5000 })
 
 ### retryResolve
 
-同全局配置，仅本次请求有效，设置重试判断策略，默认 network，可选 status
+同全局配置，仅本次请求有效，设置重试判断策略，默认 network
 
 ### retryInterval
 
-同全局配置，仅本次请求有效，设置两次请求中间的间隔，单位 ms，可以设置为数字或返回数字的函数
+同全局配置，仅本次请求有效，默认 1000ms
 
 ## 响应内容
 
@@ -325,7 +349,7 @@ setConfig({ timeout: 5000 })
 
 ### headers
 
-类型：Record<string, string | undefined> 
+类型：Record<string, string | undefined>
 
 说明：响应的头信息，全部字段名均被转成小写
 
@@ -433,7 +457,7 @@ const { ok, data } = await post(url, formData, typeGuard);
 
 ```typescript
 setGlobalConfig({
-    message: function({ code, status }:IResponseResult, method: string, url: string, defaultMsg: string){
+    message: function({ code, status, message }, method, url, defaultMsg){
         if(code === "NetworkError" || code === "Failed" || code === "Aborted") {
             return "⚠️ 网络错误，请检查网络";
         }
@@ -446,7 +470,7 @@ setGlobalConfig({
         if(code === "Unknown") {
             return `⛔ ${url} 出现未知错误，请稍候再试`;
         }
-        return defaultMsg;
+        return message;
     }
 })
 ```

package/coverage/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selecter that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);