Appearance
super-tools-lib - v1.74.0 / Modules / date
Module: date
Table of contents
Functions
- compareDate
- dateFormater
- dayDiff
- formatPassTime
- formatRemainTime
- formatSeconds
- getFirstDate
- getLastDate
- getQuarter
- getSecond
- monthDiff
Functions
compareDate
▸ compareDate(date1
, date2
): boolean
比较两个日期
Since
1.62.0
Example
ts
import { compareDate } from 'super-tools-lib'
compareDate('2023', '2022') // true
compareDate(new Date('2022'), new Date('2023')) // false
Parameters
Name | Type | Description |
---|---|---|
date1 | string | number | Date | 日期 |
date2 | string | number | Date | 日期 |
Returns
boolean
返回 date1 是否 大于 date2
dateFormater
▸ dateFormater(formater
, date?
): string
格式化时间
Since
1.0.0
Example
ts
'YYYY-MM-DD HH:mm:ss'
import { dateFormater } from 'super-tools-lib'
dateFormater('YYYY-MM-DD HH:mm:ss') // '2023-03-30 17:47:26'
dateFormater('YYYY/MM/DD') // '2023/03/30'
Parameters
Name | Type | Description |
---|---|---|
formater | any | 时间格式 |
date? | string | number | Date | 日期对象/时间戳 |
Returns
string
返回格式化后的日期
dayDiff
▸ dayDiff(date1
, date2
): number
计算两日期之间相差的天数
Since
1.62.0
Example
ts
import { dayDiff } from 'super-tools-lib'
dayDiff('2023', '2024') // 365
dayDiff(new Date('2023'), new Date('2024')) // 365
Parameters
Name | Type | Description |
---|---|---|
date1 | string | number | Date | 日期 |
date2 | string | number | Date | 日期 |
Returns
number
返回相差的天数
formatPassTime
▸ formatPassTime(date?
): string
当前时间距离传入的时候过去了多久
- 要求传入的时候必须小于当前时间
Since
1.62.0
Example
ts
import { formatPassTime } from 'super-tools-lib'
formatPassTime('') // '刚刚'
formatPassTime('2023-03-30') // '9小时前'
Parameters
Name | Type | Description |
---|---|---|
date? | string | number | Date | 日期 |
Returns
string
返回过去了多长时间
formatRemainTime
▸ formatRemainTime(date
): string
距离目标时间还有多久
- 要求传入的时间必须大于当前时间
Since
1.62.0
Example
ts
import { formatRemainTime } from 'super-tools-lib'
formatRemainTime('2024') // '276天13小时54分钟 57秒'
Parameters
Name | Type | Description |
---|---|---|
date | string | number | Date | 未来的时间 |
Returns
string
返回距离目标时间还有多久
formatSeconds
▸ formatSeconds(s
): string
将秒转换为hh:mm:ss格式
Since
1.62.0
Example
ts
import { formatSeconds } from 'super-tools-lib'
formatSeconds(60) // '00:01:00'
formatSeconds(2232342) // '20:05:42'
Parameters
Name | Type | Description |
---|---|---|
s | number | 秒 |
Returns
string
返回转换后的格式hh:mm:ss
getFirstDate
▸ getFirstDate<T
>(date
, formater?
): string
获取传入的日期当月的第一个日期
Since
1.62.0
Example
ts
import { getFirstDate } from 'super-tools-lib'
getFirstDate('2023-03-28') // '2023-03-01'
Type parameters
Name | Type |
---|---|
T | extends string | number | Date |
Parameters
Name | Type | Default value | Description |
---|---|---|---|
date | T | undefined | 日期 |
formater | string | 'YYYY-MM-DD' | 返回的日期格式 不传默认YYYY-MM-DD |
Returns
string
返回传入日期所在月的第一个日期
getLastDate
▸ getLastDate(date
, formater?
): string
获取传入的日期当月的最后一个日期
Since
1.62.0
Example
ts
import { getLastDate } from 'super-tools-lib'
getLastDate('2023-03') // '2023-03-31'
Parameters
Name | Type | Default value | Description |
---|---|---|---|
date | string | number | Date | undefined | 日期 |
formater | string | 'YYYY-MM-DD' | 返回的日期格式 不传默认YYYY-MM-DD |
Returns
string
返回传入日期所在月的最后一个日期
getQuarter
▸ getQuarter(date?
): number
获取日期属于哪个季度
Since
1.62.0
Example
ts
import { getQuarter } from 'super-tools-lib'
getQuarter('2023-12-12') // 4
Parameters
Name | Type | Description |
---|---|---|
date | string | number | Date | 日期 不传默认当前日期 |
Returns
number
返回第几季度
getSecond
▸ getSecond(date?
): number
获取当前时间戳(秒)
Since
1.62.0
Example
ts
import { getSecond } from 'super-tools-lib'
getSecond('2023') // 1672531200
Parameters
Name | Type | Description |
---|---|---|
date | string | number | Date | 日期 不传默认当前时间 |
Returns
number
返回转换后的时间戳(秒)
monthDiff
▸ monthDiff(data1
, data2
): number
计算两个日期之间的月数
Since
1.62.0
Example
ts
import { monthDiff } from 'super-tools-lib'
monthDiff('2023', '2024') // 12
monthDiff(new Date('2023'), new Date('2024')) // 12
Parameters
Name | Type | Description |
---|---|---|
data1 | string | number | Date | 日期 |
data2 | string | number | Date | 日期 |
Returns
number
返回相差几个月