# `@mxnet/utils`
> description
常用工具
## Usage
### `dist` 适用于 esm 规范 可直接运行在浏览器中, 兼容性考虑不建议
```ts
import {} from "@mxnet/utils";
```
### `dist.umd` 更加通用 可用直接运行在浏览器中,兼容性稳定
```html
```
### `lib` 适用于 `commonjs` 规范
```ts
const { Phone } = require("@mxnet/utils");
```
## 常用工具
### 单例模式 `(singletonPattern)`
- 需要一个函数返回值作为每次运行的返回值, 传入的函数只运行一次
```ts
import { singletonPattern, TypeInvalidValidation } from "@mxnet/utils";
const n = singletonPattern(() => new TypeInvalidValidation());
n() === n(); // true
```
### 类型判断策略着模式
> 需要注意 `typeInvalidValidation` 和 `TypeInvalidValidation` 是不同的策略者 , `typeInvalidValidation` 通过单例模式只实例化了一次 `TypeInvalidValidation`, 而 `TypeInvalidValidation` 为策略着 `class` 每次都会被实例化
- `builtInTypeStrategy` 用单例实例化了 `TypeInvalidValidation` , 并添加了一些常用的类型判断策略 ,且每个常用策略着都可以在 `@mxnet/utils` 找到他的导出
- `typeInvalidValidation` 用单例实例化了`TypeInvalidValidation`
- `TypeInvalidValidation` 类型验证策略者类
- `addTypePolicy` 新增策略
```ts
// (策略名,策略函数)
typeInvalidValidation.addTypePolicy("isEmptyObject", () => 1);
```
- `deletePolicy` 删除策略
```ts
// (策略名);
typeInvalidValidation.deletePolicy("isEmptyObject");
```
- `callTypeStrategy` 调用策略
```ts
// (策略名, 策略参数)
typeInvalidValidation.callTypeStrategy("isEmptyObject", 1);
```
```ts
import {
typeInvalidValidation,
TypeInvalidValidation,
builtInTypeStrategy,
isEmptyObject,
} from "@mxnet/utils";
```
### 时序控制器 `(ControlTiming)`
```ts
/**
* 创建一个时序控制器
* const httpList = new ControlTiming()
* 添加一个时序项名(name), 添加请求函数
* httpList.addTimingItems(name,httpTask)
* httpList.addTimingItems(name,httpTask)
*
*
* 触发器
* 触发的时序标识,以及触发的参数
* httpList.trigger('name',{})
*
* 监听器
* 返回响应时触发回调
* httpList.monitor('name',()=>{})
*
*/
const c = new ControlTiming()
.addTimingItems("name", async (name?: string) => {
return 1;
})
.addTimingItems("two", async () => {
return await new Promise((res) => {
res(12);
});
});
c.monitor("name", (res) => {
expect(res).toStrictEqual(1);
});
c.monitor("two", async (res) => {
expect(res).toStrictEqual(12);
});
c.trigger("name");
```
### `html2canvas`
在 `html2canvas(1.4.1)` 中兼容了 `img object-fit` 属性, 打印时不能将图片放入`div`当作 `background-image` 使用， 这样只会更模糊
```ts
import html2canvas from "@mxnet/utils/html2canvas";
```
```html
```
### 转盘
```html
```
## 验证类型
### `Phone`
```ts
import { Phone } from "@mxnet/utils";
```
```html
// 引入文件
```
#### `options`
- 验证程度:`默认宽松`,存在`最宽松(loose)`,`宽松(loosest)`,`严谨(rigorous)`，三种验证模式
```ts
// 修改验证程度
new Phone("phone", {
stringency: "rigorous",
// 也可以自定义验证
customRules: /test/g,
});
```
- 当验证失败时会立即报错(`throw`)且不会继续向下执行
```ts
new Phone("phone", {
// 手动关闭自动抛错行为
errorThrowsImmediately: false,
// 当关闭自动抛错行为,验证错误后会回调 verificationFailedn 函数, 否则会调用 throwHandling
verificationFailed() {},
throwHandling() {},
});
```
```ts
const phone = new Phone("13983912420");
phone.getPhone();
```
## 基本类型
### `RandomNumberInterval`(取随机数区间)
```ts
import { RandomNumberInterval } from "@mxnet/utils";
// 默认的随机数是小数，通过isInteger参数取整
const n = new RandomNumberInterval([5, 10], { isInteger: true });
n.getNumber();
```
```html
// 引入文件
```