0.0.2 • Published 1 year ago

lwj-utils v0.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
1 year ago

l-utils

介绍

一款简单的数据处理工具库。

安装

  1. npm
npm i lwj-utils -D
  1. browser
<script src="https://unpkg.com/browse/lwj-utils@0.0.2/dist/index.umd.js"></script>

Array

unique

针对数组进行去重,可传入关键属性对对象元素进行过滤。返回过滤后的新数组。

语法
// 普通去重
unique();

// 针对对象元素某一属性进行去重以及为空过滤
unique(key);
参数:
参数类型是否必须可选值说明
keystring-对象元素过滤的关键属性名
返回值

返回过滤后的新数组。

示例
const arr = [
  1,
  1,
  2,
  "2",
  { id: 2, name: "name1" },
  { id: 2, name: "name2" },
  { id: "", name: "name3" },
];

// 不传参数时直接进行最基本的元素去重
arr.unique(); // [1, 2, '2', { id: 2, name: "name1" }, { id: 2, name: "name2" }, { id: "", name: "name3" },]

// 传入字符串id,当元素为对象时根据id进行去重过滤
arr.unique("id"); // [1, 2, '2', { id: 2, name: "name1" }]

Number

format

格式化数字,返回格式化后的字符串。

语法
// 按千分位进行分隔
format(separator);

// 固定小数位数
format(separator, decimals);
参数:
参数类型是否必须可选值说明
separatorstring-千分位分隔符
decimalsnumber-小数位数
返回值

返回格式化后的字符串。

示例
const num = 1234567;

// 按千分位进行分隔
num.format(","); // 1,234,567

// 保留固定小数位数
num.format(",", 2); // 1,234,567.00

Date

format

针对日期进行格式化,返回满足格式的日期字符串,若日期格式错误,则返回Invalid Date

语法
format(formatStr);
参数:
参数类型是否必须可选值说明
formatStrstring-格式化占位符,支持如下字符:
标识示例描述
YY18年,两位数
YYYY2018年,四位数
Q1-4季度,一位数
QQ01-04季度,两位数
M1-12月份,从 1 开始
MM01-12月份,两位数
MMMJan-Dec月份,英文缩写
MMMMJanuary-December月份,英文全称
D1-31日期,从 1 开始
DD01-31日期,两位数
d0-6星期几,星期天是 0
ddSu-Sa最简写的星期几
dddSun-Sat简写的星期几
ddddSunday-Saturday星期几,英文全称
H0-23小时,24h 制
HH00-23小时,24h 制,两位数
h0-12小时,12h 制
hh01-12小时,12h 制,两位数
m0-59分钟
mm00-59分钟,两位数
s00-59
ss00-59秒,两位数
S0-9毫秒(十),一位数
SS0-99毫秒(百),两位数
SSS0-999毫秒(千),三位数
Z-05:00UTC 的偏移量,±HH:mm
ZZ-0500UTC 的偏移量,±HH:mm
AAM / PM上/下午,大写
aam / pm上/下午,小写
返回值

返回格式化后的字符串。

示例
const date = new Date("2023/01/01");

date.format("YYYY-MM-DD"); // 2023-01-01
date.format("YYYY-MM-DD HH:mm:ss"); // 2023-01-01 00:00:00
add

增加一定时间,返回增加后的日期对象。

语法
add(number, unit);
参数
参数类型是否必须可选值说明
numbernumber-需要增加的数量,若为负数代表减去
unitstringyear、quarter、month、week、day、hour、minute、second、millisecond需要增加的单位
返回值

返回增加后的日期对象。

示例
const date = new Date("2023/01/01");
date.add(1, "day"); // Mon Jan 02 2023 00:00:00 GMT+0800 (中国标准时间)
subtract

减去一定时间,返回减去后的日期对象。

语法
subtract(number, unit);
参数
参数类型是否必须可选值说明
numbernumber-需要增加的数量,若为负数代表增加
unitstringyear、quarter、month、week、day、hour、minute、second、millisecond需要增加的单位
返回值

返回减去后的日期对象。

示例
const date = new Date("2023/01/01");
date.subtract(1, "day"); // Sat Dec 31 2022 00:00:00 GMT+0800 (中国标准时间)

返回指定单位下相对于另一个日期之间的差异。

语法
diff(date, unit);
参数
参数类型是否必须可选值说明
dateDate-相比较的日期
unitstringyear、quarter、month、week、day、hour、minute、second、millisecond差异单位
返回值

返回差异的数量。

示例
new Date("2023/01/01").diff(new Date("2022/01/02"), "day"); // 364
startOf

startOf()方法用于设置一个时间的开始,并返回对应的开始时间。

语法
startOf(unit);
参数
参数类型是否必须可选值说明
unitstringyear、quarter、month、week、day、hour、minute、second、millisecond开始单位
返回值

返回对应的开始日期对象。

示例
new Date().startOf("year"); // Sun Jan 01 2023 00:00:00 GMT+0800 (中国标准时间)
endOf

endOf()方法用于设置一个时间的结束,并返回对应的结束时间。

语法
endOf(unit);
参数
参数类型是否必须可选值说明
unitstringyear、quarter、month、week、day、hour、minute、second、millisecond结束单位
返回值

返回对应的结束日期对象。

示例
new Date().endOf("year"); // Sun Dec 31 2023 23:59:59 GMT+0800 (中国标准时间)
getQuarter

根据本地时间,返回一个指定的日期对象为哪一个季度。

语法
getQuarter();
参数
参数类型是否必须可选值说明
-----
返回值

返回一个指定的日期对象为哪一个季度。1-4。

示例
new Date().getQuarter(); // 1
getMonthDays

返回一个指定的日期对象所在月份的天数。

参数
参数类型是否必须可选值说明
-----
返回值

返回一个指定的日期对象所在月份的天数。

示例
new Date().getMonthDays(); // 31