docs/general.md · caofen/wasei-useful-util

### general
提供基础功能函数

* chain
  > 函数之间形成链式调用，函数之间可以返回普通类型和复杂类型
  > 如果返回值为普通类型且为false，将退出当前链式调用
  > 如果返回值为复杂类型，包含status(状态)和value(实际值)两个属性，如果status属性为false，也将退出当前链式调用

| 参数 | 必填 | 说明 | 类型 |
  |-------|-------|-------|-------|
  | func | 是 | 函数 | Function |

```js
    import * as general from 'wasei-useful-util/general';
    const finalFunc1 = general.chain(result => result * 10).chain((n1, n2) => n1 + n2);
    console.log(finalFunc1(1, 2)); // => 30
  ```

* formatDate
> 格式化日期

| 参数 | 必填 | 说明 | 类型 |
|-------|-------|-------|-------|
| date | 是 | 日期或时间戳 | Date,Number |
| format | 否[format='yyyy-MM-dd HH:ii:ss'] | 日期格式；yyyy:年 MM:月 dd:日 HH:时 ii:分 ss: 秒 | String |

```js
  import * as general from 'wasei-useful-util/general';
  console.log(general.formatDate()); // => 2024-05-17 10:29:32
```

* createRandom
> 获取min-max之间的随机数

| 参数 | 必填 | 说明 | 类型 |
|-------|-------|-------|-------|
| min | 是 | 最小值 | Number |
| max | 否 | 最大值，不存在时候, max为min，min为0 | Number |

```js
  import * as general from 'wasei-useful-util/general';
  console.log(general.createRandom(3, 10)); // => 7
```

* uniqArray
> 数组去重

| 参数 | 必填 | 说明 | 类型 |
|-------|-------|-------|-------|
| arr| 是 | 去重数组 | Array |

```js
  import * as general from 'wasei-useful-util/general';
  // 普通类型元素去重
  console.log(general.uniqArray([ 3, '3', 3, true, 'true', 'true', 'false', false, false, 'a' ])); // => [3, '3', true, 'true', 'false', false, 'a']
  
  // 复杂类型去重
  console.log(general.uniqArray([ [1, 2], [ 1, 2 ], [ 1, 2, 3 ], { name: 'wjj' }, { name: 'wjj' }, { name: 'wjj', age: 21 } ])); // => [ [ 1, 2 ], [ 1, 2, 3 ], { name: 'wjj' }, { name: 'wjj', age: 21 } ]

// 特殊值去重
  console.log(general.uniqArray([ null, 'null', NaN, NaN, 'undefined', undefined, {} ])); // => [ null, 'null', NaN, 'undefined', undefined, {} ]
```

* flatArray
> 扁平化数组

| 参数 | 必填 | 说明 | 类型 |
|-------|-------|-------|-------|
| arr | 是 | 待扁平化的数组 | Array |
| depty | 否 | 扁平层数，默认无限扁平 | Number |

```js
  import * as general from 'wasei-useful-util/general';
  const arr = [ 1, [ 2 ], [ 3, [ 4 ] ], [ 5, [ 6 ], [ [ 7 ]] ] ];

// 扁平化2层
  console.log(general.flatArray(arr, 2)); // => [ 1, 2, 3, 4, 5, 6, [ 7 ] ]

// 无限扁平
  console.log(general.flatArray(arr)); // => [ 1, 2, 3, 4, 5, 6, 7 ]
```

* deepCopy
> 数组或对象深拷贝

| 参数 | 必填 | 说明 | 类型 |
|-------|-------|-------|-------|
| entity  | 是 | 待拷贝的数组或对象 | Array,Object |

```js
  import * as general from 'wasei-useful-util/general';

// 深拷贝数组
  const arr = [ 1, 2, [ 3, 4 ] ];
  const arrCopyed = general.deepCopy(arr);
  console.log(arr !== arrCopyed); // => true
  console.log(arr[ 2 ] !== arrCopyed[ 2 ]); // true

// 深拷贝对象
  const obj = { name: 'wjj', sku: { id: 1, price: 10.1 } };
  const objCopyed = general.deepCopy(obj);
  console.log(obj !== objCopyed); // => true
  console.log(obj.sku !== objCopyed.sku); // true
```

* querystring
> 将查询参数对象转成key1=val1&key2=val2等查询字符串

| 参数 | 必填 | 说明 | 类型 |
|-------|-------|-------|-------|
| qs | 是 | 查询参数对象 | Object |

```js
  import * as general from 'wasei-useful-util/general';
  const queryObj = { name: 'wjj', age: 21, id: 1 };
  const qs = general.querystring(queryObj);
  console.log(qs === 'name=wjj&age=21&id=1'); // => true
```

* mergeArr
> 合并数组

| 参数 | 必填 | 说明 | 类型 |
|-------|-------|-------|-------|
| fir | 是 | 待合并数组1 | Array |
| sec | 是 | 待合并数组2 | Array |

```js
  import * as general from 'wasei-useful-util/general';
  const targetArr = [ 1, 2, 3, [ 'a', 'd' ] ];
  const sourceObj = [ 1, 'a', false, [ 'a', 'bv' ] ];
  const mergedArr = general.mergeArr(targetArr, sourceObj);
  console.log(mergedArr); // => [ 1, [ 2, 'a' ], [ 3, false ], [ 'a', [ 'd', 'bv' ] ] ];
```

* mergeObj
> 合并对象

| 参数 | 必填 | 说明 | 类型 |
|-------|-------|-------|-------|
| fir | 是 | 待合并对象1 | Object |
| sec | 是 | 待合并对象2 | Object |

```js
  import * as general from 'wasei-useful-util/general';

* formatAmount
> 格式化金额

| 参数 | 必填 | 说明 | 类型 |
|-------|-------|-------|-------|
| amount | 是 | 金额 | Number |
| digit | 否 | 分位数[ digit=3 ] | Number |

```js
  import * as general from 'wasei-useful-util/general';

const val = general.formatAmount(34500201234, 3);
  console.log(val); // => '34,500,201,234'
```

* sleep
> 程序休眠多少秒

| 参数 | 必填 | 说明 | 类型 |
|-------|-------|-------|-------|
| sec | 是 | 秒 | Number |

```js
  import * as general from 'wasei-useful-util/general';
  
  general.sleep(3);
```

caofen/wasei-useful-util

简介

发行版

贡献者

近期动态

caofen/wasei-useful-util .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

caofen/wasei-useful-util