m8-framework-mcp 1.0.0

package/docs/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/001-base64.md

@@ -0,0 +1,142 @@
+# Util.base64
+
+## 使用场景
+
+- `base64` 需要转换成 `blob` 对象
+
+- `blob` 对象转换成 `base64`
+
+- 获取 `base64` 的 `mime` 类型
+
+- 获取 `base64` 的 `url` 部分
+
+- 获取 `base64` 去除 `url` 部分
+
+- 注意在小程序（微信、支付宝）中使用，不存在 `blob` 对象，需要使用`ArrayBuffer`替代
+
+## 方法说明
+
+注：此工具集下的方法以 `Util.base64` 为前缀进行调用
+
+### base64ToBlob(base64)
+
+将 `base64` 转换成 `blob` 对象
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     x      |      x       |
+
+**示例**
+```js
+// 返回转换完成后的 blob 对象
+Util.base64.base64ToBlob(base64);
+```
+
+### blobToBase64(file, callback)
+
+将 `blob` 对象转换成 `base64`
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     x      |      x       |
+
+__参数说明__
+
+| 参数     | 参数类型 | 说明                                |
+| -------- | -------- | ----------------------------------- |
+| file     | Blob     | `必选` 文件对象                     |
+| callback | Function | `必须` 返回转换完成后的 `base64` 值 |
+
+**示例**
+```js
+Util.base64.blobToBase64(file, b64 => {
+  // 这里获取到转换完成后的 base64 值
+});
+```
+
+### getMime(base64)
+
+获取 `base64` 的 `mime` 类型
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+Util.base64.getMime(base64);
+```
+
+### getBase64Url(base64)
+
+获取 `base64` 的 `url` 部分
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+// data:image/jpeg;base64
+Util.base64.getBase64Url(base64);
+```
+
+### getBase64NotUrl(base64)
+
+获取 `base64` 去除 `url` 部分
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+// /9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBA
+Util.base64.getBase64NotUrl(base64);
+```
+
+
+### base64ToArrayBuffer(base64)
+
+将 `base64` 转成 `ArrayBuffer` 对象
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+Util.base64.base64ToArrayBuffer(base64)
+```
+
+### arrayBufferToBase64(arrayBuffer)
+
+将 `ArrayBuffer` 对象转成 `base64` 字符串
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+Util.base64.arrayBufferToBase64(arrayBuffer)
+```

package/docs/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/002-date.md

@@ -0,0 +1,210 @@
+# Util.date
+
+## 使用场景
+
+涉及到日期操作时用到，这个类继承自Date类，拥有原有类的所有方法和属性。
+
+## 初始化
+
+必须先获取到 `MyDate` 对象并进行初始化，然后再操作
+
+```js
+const MyDate = new Util.MyDate();
+```
+
+注意，这个对象继承自 `Date`，拥有它的全部属性以及它原型上的所有属性
+
+而且`new MyDate()`和`new Date()`解析过程一致
+
+**注意**
+
+微信小程序开发者工具中，MyDate实例未继承 Util.MyDate 原型上属性，但在真机没有问题。
+为了方便开发者工具中调试，可以添加以下代码进行兼容：
+
+```js
+MyDate.__proto__ = Util.MyDate.prototype;
+```
+
+## 静态方法
+
+注：直接 `MyDate.xxx()` 调用
+
+### parseDate(dateString, pattern)
+
+将传入的日期字符串，按格式解析成 `MyDate` 对象
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+__参数说明__
+
+| 参数 | 参数类型 | 说明 |
+| --- | --- | --- |
+| dateString | String | 需解析的日期字符串 |
+| pattern | String | 匹配字符串，可以手动传入，或者采用默认值 `YYYY-MM-DD hh:mm:ss:iii` |
+
+注意：返回的是 `MyDate` 对象，继承自 `Date`，如果第一个参数不是传的字符串，就和 `new Date()` 时的解析效果一样。
+
+**示例**
+
+```js
+// 按当前日期时间解析
+const date1 = MyDate.parseDate();
+
+// 按默认的匹配格式解析：YYYY-MM-DD hh:mm:ss:iii
+const date2 = MyDate.parseDate('2022-01-01 00:00:00');
+
+// 按默认的匹配格式解析：YYYY-MM-DD hh:mm:ss:iii
+const date3 = MyDate.parseDate('2022/01/01');
+
+// 按特定的匹配格式解析：YYYY-MM-DD
+// 譬如这个会忽略日期后的所有参数（默认成0）
+const date4 = MyDate.parseDate('2022-01-01 00:00:00', 'YYYY-MM-DD');
+```
+
+
+## 对象方法说明
+
+调用方式：
+
+```js
+const myDate = new MyDate(...);
+
+myDate.xxx();
+```
+
+### Date对象的所有属性
+
+myDate 拥有 Date 对象的所有属性
+
+### format(format)
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+__参数说明__
+
+| 参数 | 参数类型 | 说明 |
+| --- | ---- | ---- |
+| format | String | 需要输出的格式，注意，`YMDhmsiw`这些关键字分别代表着`年月日时分秒毫秒星期`等概念 |
+
+**示例**
+
+```js
+const date = MyDate.parseDate('2022-01-01');
+
+// 2022-01-01
+date.format('YYYY/MM/DD');
+
+// 2022年01月01日 00小时00分钟00秒000毫秒 星期1
+date.format('YYYY年MM月DD日 HH小时mm分钟ss秒iii毫秒 星期w');
+```
+
+**注意**
+
+微信小程序开发者工具中，MyDate.parseDate 返回的 date 对象未继承 Util.MyDate 原型上属性，但在真机没有问题。
+为了方便开发者工具中调试，可以添加以下代码进行兼容：
+
+```js
+date.__proto__ = Util.MyDate.prototype;
+```
+
+### getAbsoluteMillonsTime(isTimezoneOffsetFixed)
+
+返回从1970-01-01 00:00:000到现在的绝对毫秒数
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+__参数说明__
+
+| 参数 | 参数类型 | 说明 |
+| --- | ---- | ---- |
+| format | String | 需要输出的格式，注意，`YMDhmsiw`这些关键字分别代表着`年月日时分秒毫秒星期`等概念 |
+
+**示例**
+
+```js
+const date = MyDate.parseDate('2022-01-01');
+
+// 1515142825154（仅举例，随着时间变
+date.getAbsoluteMillonsTime();
+
+// 补上和GMT时区的误差
+// 1515114083170（仅举例，随着时间变）
+date.getAbsoluteMillonsTime(true);
+```
+
+### toTimeStap(isTimezoneOffsetFixed)
+
+用法同`getAbsoluteMillonsTime`，只不过是换成字符串输出
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+### compare(another, pattern)
+
+和另一个MyDate类型的时间比较
+
+如果当前时间大于`another`，返回结果大于`0`，小于的话结果小于0，否则等于0
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+__参数说明__
+
+| 参数 | 参数类型 | 说明 |
+| --- | --- | --- |
+| another | MyDate | 需要被比较的时间，必须是MyDate对象 |
+| pattern | String | 比较模式，可选为`YMDhmsi`中的一个，默认为 `s` 代表精确到秒 |
+
+**示例**
+
+```js
+const date1 = MyDate.parseDate();
+const date2 = MyDate.parseDate('2022-01-01');
+
+console.log('比较结果：' + date1.compare(date2, 's'));
+```
+
+### nextSeconds(num)
+
+获取往后n秒的时间。返回的是一个新的MyDate对象
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+__参数说明__
+
+| 参数 | 参数类型 | 说明 |
+| --- | --- | --- |
+| num | Number | 往后多少秒，譬如 `5` 代表往后5秒，可以传负数，负数代表向前，默认为`0` |
+
+**示例**
+
+```js
+const date1 = MyDate.parseDate('2022-01-01');
+
+// 获取date1往后5秒的时间，然后输出，精确到秒
+console.log('输出结果：' + date1.nextSeconds(5).format('YYYY-MM-DD hh:mm:ss'));
+```
+
+

package/docs/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/004-math.md

@@ -0,0 +1,85 @@
+# Util.math
+
+## 说明
+
+计算机编程语言里浮点数计算会存在精度丢失问题（或称舍入误差），其根本原因是二进制和实现位数限制有些数无法有限表示。
+
+例如：
+
+```
+0.1 + 0.2 == 0.30000000000000004
+0.2 + 0.4 == 0.6000000000000001
+0.1 * 0.2 == 0.020000000000000004
+```
+
+## 使用场景
+
+- 使用此方法可规避以上出现浮点数加减乘除精度丢失的问题
+
+## 方法说明
+
+注：此工具集下的方法以 `Util.math` 为前缀进行调用
+
+### add(number1, number2)
+
+浮点数相加
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+Util.math.add(0.1, 0,2);  // 0.3
+```
+
+### subtract(number1, number2)
+
+浮点数相减
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+Util.math.subtract(3, 2.9);  // 0.1
+```
+
+### multiply(number1, number2)
+
+浮点数相乘
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+Util.math.multiply(0.3, 3);  // 0.9
+```
+
+### divide(number1, number2)
+
+浮点数相除
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+Util.math.divide(0.3, 3);  // 0.1
+```

package/docs/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/006-sha1.md

@@ -0,0 +1,21 @@
+# Util.sha1
+
+## 使用场景
+
+- 不建议使用 `sha1`，而是应该使用更安全的 `sha256`
+
+- 一些特殊场景下，如服务端使用了 `sha1`，可以使用这个工具类
+
+## 方法说明
+
+基本用法与 `sha256` 一致，注意
+
+- 调用前缀是 `Util.sha1`，而不是 `Util.sha256`
+
+- 使用方法 `Util.sha1.hex(str)`
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |

package/docs/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/007-sha256.md

@@ -0,0 +1,36 @@
+# Util.sha256
+
+## 使用场景
+
+- 服务端存储的是 `sha256` 散列过后的密码，此时客户端也需要用 `sha256` 对密码进行处理
+
+- 可以通过在线工具测试[在线加密解密(采用Crypto-JS实现)](http://tool.oschina.net/encrypt?type=2)
+
+## 方法说明
+
+注：此工具集下的方法以 `Util.sha256` 为前缀进行调用
+
+#### hex(str)
+
+将目标字符串进行 `sha256` 散列，并且返回小写形式的`16进制字符串`
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+__参数说明__
+
+| 参数 | 参数类型 | 说明 |
+| --- | --- | --- |
+| str | String | 目标字符串，只支持`UTF-16`编码形式，可以认为，`JS`中默认的输入就是`UTF-16`形式 |
+
+**示例**
+
+```js
+const str = '我的密码是:abcd123';
+
+// 59858ba03b7b2eca0673bd55f2c8685b8782a0f57bec12f8082aa9934cddcb51
+Util.sha256.hex(str);
+```

package/docs/m8mpdoc-develop/006-Util/345/267/245/345/205/267/351/233/206/008-storage.md

@@ -0,0 +1,128 @@
+# Util.storage
+
+## 使用场景
+
+应用中用到数据存储的地方
+
+## 方法说明
+
+注：此工具集下的方法以 `Util.storage` 为前缀进行调用
+
+H5、新点小程序端为`localStorage`，浏览器限制5M大小，是缓存概念，可能会被清理;
+
+微信、支付宝小程序端为其自带的`storage` api，数据存储生命周期跟小程序本身一致，即除用户主动删除或超过一定时间被自动清理，否则数据都一直可用;
+
+微信小程序单个 key 允许存储的最大数据长度为 1MB，所有数据存储上限为 10MB;
+
+支付宝小程序单条数据转换成字符串后，字符串长度最大200*1024。同一个支付宝用户，同一个小程序缓存总上限为10MB;
+
+### setItem(key, value)
+
+存储键值对
+
+存储的value如果为对象类型，默认均会尝试转成JSON字符串进行存储
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+Util.storage.setItem('key1', '{"1":"2"}');
+```
+
+### getItem(key, isJson)
+
+读取键值对，可以控制是否自动转为JSONObject对象
+
+返回的内容默认均为字符串类型
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+__参数说明__
+
+| 参数 | 参数类型 | 说明 |
+| --- | --- | --- |
+| isJson | Boolean | 是否自动转为`JSONObject`对象，如果为`true`，会尝试自动转换，如果转换失败，则返回原来的字符串 |
+
+**示例**
+
+```js
+// {1: "2"}
+Util.storage.getItem('key1');
+
+// Object {1: "2"}
+Util.storage.getItem('key1', true);
+```
+### removeItem(key)
+
+移除键值对
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+Util.storage.removeItem('key1');
+```
+
+### clear()
+
+清空所有键值对
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+**示例**
+
+```js
+Util.storage.clear();
+```
+
+### each(callback, options)
+
+遍历键值对
+
+**平台差异**
+
+|  H5   | 新点小程序 | 微信小程序 | 支付宝小程序 |
+| :---: | :--------: | :--------: | :----------: |
+|   √   |     √      |     √      |      √       |
+
+__options配置说明__
+
+| 参数 | 参数类型 | 说明 |
+| --- | --- | --- |
+| isJson | Boolean | 是否自动转为`JSONObject`对象，如果为`true`，会尝试自动转换，如果转换失败，则返回原来的字符串 |
+| include | RegExp或Array[RegExp] | 需要过滤的正则表达式或数组，如果不传默认为所有都可以 |
+| exclude | RegExp或Array[RegExp] | 需要排除的正则表达式或数组，如果不传默认为不排除 |
+
+**示例**
+
+```js
+Util.storage.each(function(key, value) {
+    console.log(key + ':' + value);
+},
+{
+    isJson: false,
+    // 只允许 key开头的键
+    include: /^key/,
+    // 排除 a开头的键
+    exclude: /^a/
+});
+```
+