🚕 hlyy-front插件文档

310 阅读3分钟

这是我参与11月更文挑战的第9天,活动详情查看:2021最后一次更文挑战

写在前面:

  • 欢迎加入博主的前端学习qq交流群::706947563专注前端开发,共同学习进步

🍳 What is hlyy-front?

hlyy-front主要是将在前端开发中常用的方法函数及企业级中后台产品UI组件进行二次封装,针对时下的业务场景便于开发、维护的一个混合库(混合库指的是既包含方法库又包含组件库)。


🍷 安装与使用

  • 在node.js环境下
 npm install @hlyy-front/master-tool
import { transferFloat } from '@hlyy-front/master-tool';

🥧 方法实例详解

📏 transferFloat()

小数处理函数。将一个数字转化为指定为保留几位小数的数,返回的值为你想要的那个保留几位小数的数,返回类型为number。

应用场景:

3.6668 --> 3.66

6 --> 6.00

7.1 --> 7

调用方法如下:

 transferFloat(6);

函数入参说明:

transferFloat (num: number, toFixNum:number = 2, roundingOff:boolean = true)
参数是否必传类型描述
numnumber要进行处理的数字
toFixNumnumber默认值为2。指需要保留为几位小数
roundingOffboolean默认为true。指小数位是否进行四舍五入

例子:

如果我想将12.567 转化为 保留1位小数(最后一位小数不四舍五入)的数,那么可以这样调用函数:

transferFloat(12.567,1,flase);

输出为:12.5

🕛 areDataReckon()

获取日期函数。这个方法可以获取一个时间范围,返回值类型是一个moment格式数组,这种[YYYY-MM-DD,YYYY-MM-DD]时间格式。

应用场景:

- 获取上周的时间段
- 获取上月的时间段
- 获取近一周的时间段

调用方法如下:

areDataReckon('上周');

函数入参说明:

areDataReckon(type: string)
参数是否必传类型描述
type是(需要传指定值)string传入我们想要获取的那个时间段。可选参数如下:本日上日上周上月上季度上年本日近一周近一月近一年。
  • 入参值type进一步解释,当我们选择不同的入参时将会返回如下内容:
type入参返回内容
本日返回今天的年月日,开始和结束日期都是今天。【年月日,年月日】
上日返回昨天的年月日,开始和结束日期都是昨天。
上周返回上周的年月日,开始日期为上周星期一,结束日期为上周星期日。
上月返回上月的年月日,开始日期为上月1号,结束日期为上月最后一天。
上季度返回上季度的年月日,开始日期为上季度第一天,结束日期为上季度最后一天。
上年返回上年的年月日,开始日期为上年1月1号,结束日期为上年最后一天。
近一周返回近一周的年月日,开始日期为包括今天往前推七天,结束日期为今天。
近一月返回近一月的年月日,开始日期为包括今天往前推30天,结束日期为今天。
近一年返回上周的年月日,开始日期为包括今天往前推365天,结束日期为今天。

例子:

如果想获取近一周的时间段,那么可以像如下这样写:

console.log('areDataReckon("上周"):', areDataReckon('上周'))

控制台输出为:

image-20211116203612028

🏊‍♂️ areRinseObj()

清洗对象函数。该函数主要功能为将对象里面值为undefied、null、'' 这些属性清洗掉,返回值是一个“干净"的对象。

应用场景:

- 前端传值给后端,值为这样
{
  userName:'user01',
  issue:undefined,
  remark:null,
  photo:''
}

如上,使用areRinseObj函数清洗完返回的就是

{
  userName:'user01'
}

调用方法如下:

areRinseObj(obj); // obj为要传入的对象

函数入参说明:

参数是否必传类型描述
objobject传入要清洗的对象

🥦 组件实例详解

待更新。