chain <a class="header-anchor" href="#chain" aria-label="Permalink to &quot;chain&quot;">​

this

addDays()

addDays(days): this

定义于: dist/types/index.d.ts:120

参数

days

number

this

addHours()

addHours(hours): this

定义于: dist/types/index.d.ts:121

参数

hours

number

this

addMilliseconds()

addMilliseconds(ms): this

定义于: dist/types/index.d.ts:122

参数

ms

number

this

addMinutes()

addMinutes(minutes): this

定义于: dist/types/index.d.ts:123

参数

minutes

number

this

addMonths()

addMonths(months): this

定义于: dist/types/index.d.ts:124

参数

months

number

this

addYears()

addYears(years): this

定义于: dist/types/index.d.ts:125

参数

years

number

this

clone()

clone(): IDateChain

定义于: dist/types/index.d.ts:188

IDateChain

date()

调用签名

date(date): this

定义于: dist/types/index.d.ts:164

参数

date

number

this

调用签名

date(): number

定义于: dist/types/index.d.ts:165

number

day()

调用签名

day(day): this

定义于: dist/types/index.d.ts:166

参数

day

number

this

调用签名

day(): number

定义于: dist/types/index.d.ts:167

number

dayOfYear()

调用签名

dayOfYear(): number

定义于: dist/types/index.d.ts:126

number

调用签名

dayOfYear(val): this

定义于: dist/types/index.d.ts:127

参数

val

number

this

daysInMonth()

daysInMonth(): number

定义于: dist/types/index.d.ts:128

number

diff()

diff(input, unit, asFloat?): number

定义于: dist/types/index.d.ts:129

参数

input

unit

asFloat?

boolean

number

diffInDays()

diffInDays(input, asFloat?): number

定义于: dist/types/index.d.ts:130

参数

input

asFloat?

boolean

number

diffInHours()

diffInHours(input, asFloat?): number

定义于: dist/types/index.d.ts:131

参数

input

asFloat?

boolean

number

diffInMilliseconds()

diffInMilliseconds(input, asFloat?): number

定义于: dist/types/index.d.ts:132

参数

input

asFloat?

boolean

number

diffInMinutes()

diffInMinutes(input, asFloat?): number

定义于: dist/types/index.d.ts:133

参数

input

asFloat?

boolean

number

diffInMonths()

diffInMonths(input, asFloat?): number

定义于: dist/types/index.d.ts:134

参数

input

asFloat?

boolean

number

diffInSeconds()

diffInSeconds(input, asFloat?): number

定义于: dist/types/index.d.ts:135

参数

input

asFloat?

boolean

number

diffInYears()

diffInYears(input, asFloat?): number

定义于: dist/types/index.d.ts:136

参数

input

asFloat?

boolean

number

endOf()

endOf(unit): this

定义于: dist/types/index.d.ts:137

参数

unit

this

format()

format(formatString?): string

定义于: dist/types/index.d.ts:138

参数

formatString?

string

get()

get(unit): number

定义于: dist/types/index.d.ts:139

参数

unit

number

hour()

调用签名

hour(hour): this

定义于: dist/types/index.d.ts:168

参数

hour

number

this

调用签名

hour(): number

定义于: dist/types/index.d.ts:169

number

hours()

调用签名

hours(hours): this

定义于: dist/types/index.d.ts:179

参数

hours

number

this

调用签名

hours(): number

定义于: dist/types/index.d.ts:180

number

isAfter()

isAfter(input, unit): boolean

定义于: dist/types/index.d.ts:140

参数

input

unit

boolean

isBefore()

isBefore(input, unit): boolean

定义于: dist/types/index.d.ts:141

参数

input

unit

boolean

isBetween()

isBetween(from, to, unit, inclusivity?): boolean

定义于: dist/types/index.d.ts:142

参数

inclusivity?

string

boolean

isLeapYear()

isLeapYear(): boolean

定义于: dist/types/index.d.ts:143

boolean

isSame()

isSame(input, unit): boolean

定义于: dist/types/index.d.ts:144

参数

input

unit

boolean

isSameOrAfter()

isSameOrAfter(input, unit): boolean

定义于: dist/types/index.d.ts:145

参数

input

unit

boolean

isSameOrBefore()

isSameOrBefore(input, unit): boolean

定义于: dist/types/index.d.ts:146

参数

input

unit

boolean

isValid()

isValid(): boolean

定义于: dist/types/index.d.ts:147

boolean

millisecond()

调用签名

millisecond(millisecond): this

定义于: dist/types/index.d.ts:174

参数

millisecond

number

this

调用签名

millisecond(): number

定义于: dist/types/index.d.ts:175

number

milliseconds()

调用签名

milliseconds(milliseconds): this

定义于: dist/types/index.d.ts:185

参数

milliseconds

number

this

调用签名

milliseconds(): number

定义于: dist/types/index.d.ts:186

number

minute()

调用签名

minute(minute): this

定义于: dist/types/index.d.ts:170

参数

minute

number

this

调用签名

minute(): number

定义于: dist/types/index.d.ts:171

number

minutes()

调用签名

minutes(minutes): this

定义于: dist/types/index.d.ts:181

参数

minutes

number

this

调用签名

minutes(): number

定义于: dist/types/index.d.ts:182

number

month()

调用签名

month(month): this

定义于: dist/types/index.d.ts:162

参数

month

number

this

调用签名

month(): number

定义于: dist/types/index.d.ts:163

number

second()

调用签名

second(second): this

定义于: dist/types/index.d.ts:172

参数

second

number

this

调用签名

second(): number

定义于: dist/types/index.d.ts:173

number

seconds()

调用签名

seconds(seconds): this

定义于: dist/types/index.d.ts:183

参数

seconds

number

this

调用签名

seconds(): number

定义于: dist/types/index.d.ts:184

number

set()

set(unit, val): this

定义于: dist/types/index.d.ts:148

参数

unit

val

number

this

startOf()

startOf(unit): this

定义于: dist/types/index.d.ts:149

参数

unit

this

subDays()

subDays(days): this

定义于: dist/types/index.d.ts:150

参数

days

number

this

subHours()

subHours(hours): this

定义于: dist/types/index.d.ts:151

参数

hours

number

this

subMilliseconds()

subMilliseconds(time): this

定义于: dist/types/index.d.ts:152

参数

time

number

this

subMinutes()

subMinutes(minutes): this

定义于: dist/types/index.d.ts:153

参数

minutes

number

this

subMonths()

subMonths(months): this

定义于: dist/types/index.d.ts:154

参数

months

number

this

subSeconds()

subSeconds(seconds): this

定义于: dist/types/index.d.ts:155

参数

seconds

number

this

subtract()

调用签名

subtract(input): this

定义于: dist/types/index.d.ts:156

参数

input

number | DateAddingObject

this

调用签名

subtract(num, unit): this

定义于: dist/types/index.d.ts:157

参数

num

number

unit

this

subYears()

subYears(years): this

定义于: dist/types/index.d.ts:158

参数

years

number

this

time()

调用签名

time(time): this

定义于: dist/types/index.d.ts:176

参数

time

number

this

调用签名

time(): number

定义于: dist/types/index.d.ts:177

number

toArray()

toArray(): number[]

定义于: dist/types/index.d.ts:189

number[]

toDate()

toDate(): Date

定义于: dist/types/index.d.ts:190

Date

toISOString()

toISOString(): string

定义于: dist/types/index.d.ts:191

string

toJSON()

toJSON(): string

定义于: dist/types/index.d.ts:192

string

toString()

toString(): string

定义于: dist/types/index.d.ts:193

string

valueOf()

valueOf(): number

定义于: dist/types/index.d.ts:194

number

year()

调用签名

year(year): this

定义于: dist/types/index.d.ts:160

参数

year

number

this

调用签名

year(): number

定义于: dist/types/index.d.ts:161

number

InnerDateParsingObject

定义于: dist/types/index.d.ts:28

属性

date?

optional date: number

定义于: dist/types/index.d.ts:31

hour?

optional hour: number

定义于: dist/types/index.d.ts:32

millisecond?

optional millisecond: number

定义于: dist/types/index.d.ts:35

minute?

optional minute: number

定义于: dist/types/index.d.ts:33

month?

optional month: number

定义于: dist/types/index.d.ts:30

second?

optional second: number

定义于: dist/types/index.d.ts:34

utcOffset?

optional utcOffset: number

定义于: dist/types/index.d.ts:36

year?

optional year: number

定义于: dist/types/index.d.ts:29

InnerUnits

定义于: dist/types/index.d.ts:55

属性

DATE

DATE: "date"

定义于: dist/types/index.d.ts:74

Date unit (日单位)

DAY

DAY: "day"

定义于: dist/types/index.d.ts:79

Day unit (日单位)

HOUR

HOUR: "hour"

定义于: dist/types/index.d.ts:84

Hour unit (时单位)

MILLISECOND

MILLISECOND: "millisecond"

定义于: dist/types/index.d.ts:99

Millisecond unit (毫秒单位)

MINUTE

MINUTE: "minute"

定义于: dist/types/index.d.ts:89

Minute unit (分单位)

MONTH

MONTH: "month"

定义于: dist/types/index.d.ts:69

Month unit (月单位)

SECOND

SECOND: "second"

定义于: dist/types/index.d.ts:94

Second unit (秒单位)

TIME

TIME: "time"

定义于: dist/types/index.d.ts:59

Time unit (时间单位)

UTC_OFFSET

UTC_OFFSET: "utcOffset"

定义于: dist/types/index.d.ts:104

UTC offset unit (时区单位)

YEAR

YEAR: "year"

定义于: dist/types/index.d.ts:64

Year unit (年单位)

类型别名

ChainInput

ChainInput = DateInput | IDateChain

定义于: dist/types/index.d.ts:115

DateInput

DateInput = string | number | Date | number[] | DateParsingObject

定义于: dist/types/index.d.ts:47

Date input type 日期输入类型

InnerUnit

InnerUnit = "year" | "month" | "date" | "day" | "hour" | "minute" | "second" | "millisecond"

定义于: dist/types/index.d.ts:53

Internal date unit 内部日期单位

Unit

Unit = "Y" | "y" | "M" | "D" | "d" | "h" | "m" | "s" | "ms" | InnerUnit | "years" | "months" | "dates" | "days" | "hours" | "minutes" | "seconds" | "milliseconds"

定义于: dist/types/index.d.ts:111

Date unit 日期单位

变量

units

const units: InnerUnits

定义于: dist/units.d.ts:2

函数

add()

调用签名

add(date, input): Date

定义于: dist/add.d.ts:2

参数

date

Date

input

number | DateAddingObject

Date

调用签名

add(date, num, unit): Date

定义于: dist/add.d.ts:3

参数

date

Date

num

number

unit

Date

addDays()

addDays(date, days): Date

定义于: dist/addDays.d.ts:14

Adds a specified number of days to a date. 向日期添加指定数量的天数。

参数

date

Date

The date to add days to. (要添加天数的日期。)

days

number

The number of days to add. (要添加的天数。)

Date

A new date with the added days. (添加天数后的新日期。)

示例

const newDate = addDays(new Date(), 5);
console.log(newDate); // Outputs the date 5 days from now (输出5天后的日期)

addHours()

addHours(date, hours): Date

定义于: dist/addHours.d.ts:16

Adds a specified number of hours to a date. 向日期添加指定数量的小时。

参数

date

Date

The date to add hours to. (要添加小时的日期。)

hours

number

The number of hours to add. (要添加的小时数。)

Date

A new date with the added hours. (添加小时后的新日期。)

示例

// Adding 3 hours to a date (向日期添加3小时)
const originalDate = new Date('2023-10-01T12:00:00');
addHours(originalDate, 3);
console.log(originalDate.toISOString()); // Outputs: '2023-10-01T15:00:00.000Z' (输出: '2023-10-01T15:00:00.000Z')

addMilliseconds()

addMilliseconds(date, ms): Date

定义于: dist/addMilliseconds.d.ts:16

Adds a specified number of milliseconds to a date. 向日期添加指定数量的毫秒。

参数

date

Date

The date to add milliseconds to. (要添加毫秒的日期。)

ms

number

The number of milliseconds to add. (要添加的毫秒数。)

Date

A new date with the added milliseconds. (添加毫秒后的新日期。)

示例

// Adding 5000 milliseconds to a date (向日期添加5000毫秒)
const originalDate = new Date('2023-10-01T12:00:00');
addMilliseconds(originalDate, 5000);
console.log(originalDate.toISOString()); // Outputs: '2023-10-01T12:00:05.000Z' (输出: '2023-10-01T12:00:05.000Z')

addMinutes()

addMinutes(date, minutes): Date

定义于: dist/addMinutes.d.ts:16

Adds a specified number of minutes to a date. 向日期添加指定数量的分钟。

参数

date

Date

The date to add minutes to. (要添加分钟的日期。)

minutes

number

The number of minutes to add. (要添加的分钟数。)

Date

A new date with the added minutes. (添加分钟后的新日期。)

示例

// Adding 30 minutes to a date (向日期添加30分钟)
const originalDate = new Date('2023-10-01T12:00:00');
addMinutes(originalDate, 30);
console.log(originalDate.toISOString()); // Outputs: '2023-10-01T12:30:00.000Z' (输出: '2023-10-01T12:30:00.000Z')

addMonths()

addMonths(date, months): Date

定义于: dist/addMonths.d.ts:16

Adds a specified number of months to a date. 向日期添加指定数量的月份。

参数

date

Date

The date to add months to. (要添加月份的日期。)

months

number

The number of months to add. (要添加的月份数。)

Date

A new date with the added months. (添加月份后的新日期。)

示例

// Adding 2 months to a date (向日期添加2个月)
const originalDate = new Date('2023-10-31T12:00:00');
addMonths(originalDate, 2);
console.log(originalDate.toISOString()); // Outputs: '2023-12-31T12:00:00.000Z' (输出: '2023-12-31T12:00:00.000Z')

addSeconds()

addSeconds(date, seconds): Date

定义于: dist/addSeconds.d.ts:16

Adds a specified number of seconds to a date. 向日期添加指定数量的秒。

参数

date

Date

The date to add seconds to. (要添加秒的日期。)

seconds

number

The number of seconds to add. (要添加的秒数。)

Date

A new date with the added seconds. (添加秒后的新日期。)

示例

// Adding 30 seconds to a date (向日期添加30秒)
const originalDate = new Date('2023-10-01T12:00:00');
addSeconds(originalDate, 30);
console.log(originalDate.toISOString()); // Outputs: '2023-10-01T12:00:30.000Z' (输出: '2023-10-01T12:00:30.000Z')

addYears()

addYears(date, years): Date

定义于: dist/addYears.d.ts:16

Adds a specified number of years to a date. 向日期添加指定数量的年份。

参数

date

Date

The date to add years to. (要添加年份的日期。)

years

number

The number of years to add. (要添加的年份数。)

Date

A new date with the added years. (添加年份后的新日期。)

示例

// Adding 2 years to a date (向日期添加2年)
const originalDate = new Date('2023-10-01T12:00:00');
addYears(originalDate, 2);
console.log(originalDate.toISOString()); // Outputs: '2025-10-01T12:00:00.000Z' (输出: '2025-10-01T12:00:00.000Z')

chain()

chain(input, format?): IDateChain

定义于: src/chain.ts:144

参数

input

format?

string

IDateChain

compile()

compile(formatString): CompileResult

定义于: dist/compile.d.ts:21

Compile a format string into a regular expression and extract date parts. 编译格式字符串，生成正则表达式和匹配的日期部分

参数

formatString

string

The format string to compile. (要编译的格式字符串。)

CompileResult

A compiled result object containing the regular expression pattern and extracted date parts. (包含正则表达式模式的编译结果对象，以及提取的日期部分。)

示例

compile('YYYY-MM-DD HH:mm:ss.SSS');
// {
//   pattern: '(\\d{1,4})-(\\d{1,2})-(\\d{1,2}) (\\d{1,2}):(\\d{1,2}):(\\d{1,2})\\.(\\d{1,3})',
//   tokens: ['YYYY', 'MM', 'DD','HH', 'mm', 'ss', 'SSS']
// }

dayOfYear()

调用签名

dayOfYear(date): number

定义于: dist/dayOfYear.d.ts:1

参数

date

Date

number

调用签名

dayOfYear(date, val): Date

定义于: dist/dayOfYear.d.ts:2

参数

date

Date

val

number

Date

daysInMonth()

daysInMonth(date): number

定义于: dist/daysInMonth.d.ts:20

Gets the number of days in the month for a given date. 获取给定日期所在月份的天数。

参数

date

Date

The date to get the number of days in the month for. (要获取月份天数的日期。)

number

The number of days in the month. (月份的天数。)

示例

// Getting the number of days in October 2023 (获取2023年10月的天数)
const date = new Date('2023-10-01');
const days = daysInMonth(date);
console.log(days); // Outputs: 31 (输出: 31)

// Getting the number of days in February 2024 (获取2024年2月的天数)
const date2 = new Date('2024-02-01');
const days2 = daysInMonth(date2);
console.log(days2); // Outputs: 29 (输出: 29)

diff()

diff(date, input, unit, asFloat?): number

定义于: dist/diff.d.ts:46

Calculates the difference between two dates in specified time units. 计算两个日期之间的指定时间单位差异。

参数

date

Date

The first date. (第一个日期。)

input

The second date. (第二个日期。)

unit

The unit of time to calculate the difference in (e.g., 'year', 'month', 'day', 'hour', 'minute', 'second', 'millisecond'). (要计算差异的时间单位，例如 'year'、'month'、'day'、'hour'、'minute'、'second'、'millisecond'。)

asFloat?

boolean

Whether to return the difference as a floating-point number. (是否以浮点数形式返回差异。)

number

The difference between the two dates in the specified time units. (两个日期之间的指定时间单位差异。)

示例

// Calculating the difference in years (计算年份差异)
const date1 = new Date('2023-01-01');
const date2 = new Date('2024-01-01');
const yearsDiff = diff(date1, date2, 'year');
console.log(yearsDiff); // Outputs: 1 (输出: 1)

// Calculating the difference in months (计算月份差异)
const monthsDiff = diff(date1, date2, 'month');
console.log(monthsDiff); // Outputs: 12 (输出: 12)

// Calculating the difference in days (计算天数差异)
const daysDiff = diff(date1, date2, 'day');
console.log(daysDiff); // Outputs: 365 (输出: 365)

// Calculating the difference in hours (计算小时差异)
const hoursDiff = diff(date1, date2, 'hour');
console.log(hoursDiff); // Outputs: 8760 (输出: 8760)

// Calculating the difference in minutes (计算分钟差异)
const minutesDiff = diff(date1, date2, 'minute');
console.log(minutesDiff); // Outputs: 525600 (输出: 525600)

// Calculating the difference in seconds (计算秒数差异)
const secondsDiff = diff(date1, date2, 'second');
console.log(secondsDiff); // Outputs: 31536000 (输出: 31536000)

// Calculating the difference in milliseconds (计算毫秒差异)
const msDiff = diff(date1, date2, 'millisecond');
console.log(msDiff); // Outputs: 31536000000 (输出: 31536000000)

diffInDays()

diffInDays(date, input, asFloat?): number

定义于: dist/diffInDays.d.ts:2

参数

date

Date

input

asFloat?

boolean

number

diffInHours()

diffInHours(date, input, asFloat?): number

定义于: dist/diffInHours.d.ts:2

参数

date

Date

input

asFloat?

boolean

number

diffInMilliseconds()

diffInMilliseconds(date, input, asFloat?): number

定义于: dist/diffInMilliseconds.d.ts:2

参数

date

Date

input

asFloat?

boolean

number

diffInMinutes()

diffInMinutes(date, input, asFloat?): number

定义于: dist/diffInMinutes.d.ts:2

参数

date

Date

input

asFloat?

boolean

number

diffInMonths()

diffInMonths(date, input, asFloat?): number

定义于: dist/diffInMonths.d.ts:2

参数

date

Date

input

asFloat?

boolean

number

diffInSeconds()

diffInSeconds(date, input, asFloat?): number

定义于: dist/diffInSeconds.d.ts:2

参数

date

Date

input

asFloat?

boolean

number

diffInYears()

diffInYears(date, input, asFloat?): number

定义于: dist/diffInYears.d.ts:2

参数

date

Date

input

asFloat?

boolean

number

endOf()

endOf(date, unit): Date

定义于: dist/endOf.d.ts:43

Sets the date to the end of the specified unit of time. 将日期设置为指定时间单位的结束时间。

参数

date

Date

The date to set to the end of the specified unit. (要设置为指定时间单位结束时间的日期。)

unit

The unit of time to set the end of (e.g., 'year', 'month', 'day', 'hour', 'minute', 'second'). (要设置结束时间的时间单位，例如 'year'、'month'、'day'、'hour'、'minute'、'second'。)

Date

A new date object set to the end of the specified unit. (设置为指定时间单位结束时间的新日期对象。)

示例

// Setting the end of the year (设置年份结束时间)
const date1 = new Date('2023-01-01');
const endOfYear = endOf(date1, 'year');
console.log(endOfYear.toISOString()); // Outputs: '2023-12-31T23:59:59.999Z' (输出: '2023-12-31T23:59:59.999Z')

// Setting the end of the month (设置月份结束时间)
const date2 = new Date('2023-10-01');
const endOfMonth = endOf(date2, 'month');
console.log(endOfMonth.toISOString()); // Outputs: '2023-10-31T23:59:59.999Z' (输出: '2023-10-31T23:59:59.999Z')

// Setting the end of the day (设置天数结束时间)
const date3 = new Date('2023-10-01T12:00:00');
const endOfDay = endOf(date3, 'day');
console.log(endOfDay.toISOString()); // Outputs: '2023-10-01T23:59:59.999Z' (输出: '2023-10-01T23:59:59.999Z')

// Setting the end of the hour (设置小时结束时间)
const date4 = new Date('2023-10-01T12:00:00');
const endOfHour = endOf(date4, 'hour');
console.log(endOfHour.toISOString()); // Outputs: '2023-10-01T12:59:59.999Z' (输出: '2023-10-01T12:59:59.999Z')

// Setting the end of the minute (设置分钟结束时间)
const date5 = new Date('2023-10-01T12:00:00');
const endOfMinute = endOf(date5, 'minute');
console.log(endOfMinute.toISOString()); // Outputs: '2023-10-01T12:00:59.999Z' (输出: '2023-10-01T12:00:59.999Z')

// Setting the end of the second (设置秒数结束时间)
const date6 = new Date('2023-10-01T12:00:00');
const endOfSecond = endOf(date6, 'second');
console.log(endOfSecond.toISOString()); // Outputs: '2023-10-01T12:00:00.999Z' (输出: '2023-10-01T12:00:00.999Z')

format()

format(date, formatString?): string

定义于: dist/format.d.ts:31

Formats a date according to the specified format string. 根据指定的格式字符串格式化日期。

参数

date

Date

The date to format. (要格式化的日期。)

formatString?

string

The format string to use. (要使用的格式字符串。)

string

The formatted date string. (格式化后的日期字符串。)

示例

// Formatting a date with 'YYYY-MM-DD' format (使用 'YYYY-MM-DD' 格式格式化日期)
const date1 = new Date('2023-10-01T12:00:00');
const formattedDate1 = format(date1, 'YYYY-MM-DD');
console.log(formattedDate1); // Outputs: '2023-10-01' (输出: '2023-10-01')

// Formatting a date with 'YYYY-MM-DD HH:mm:ss' format (使用 'YYYY-MM-DD HH:mm:ss' 格式格式化日期)
const date2 = new Date('2023-10-01T12:30:45');
const formattedDate2 = format(date2, 'YYYY-MM-DD HH:mm:ss');
console.log(formattedDate2); // Outputs: '2023-10-01 12:30:45' (输出: '2023-10-01 12:30:45')

// Formatting a date with 'YYYY-MM-DDTHH:mm:ssZ' format (使用 'YYYY-MM-DDTHH:mm:ssZ' 格式格式化日期)
const date3 = new Date('2023-10-01T12:30:45');
const formattedDate3 = format(date3, 'YYYY-MM-DDTHH:mm:ssZ');
console.log(formattedDate3); // Outputs: '2023-10-01T12:30:45-04:00' (输出: '2023-10-01T12:30:45-04:00')

// Using 'ISO' format (使用 'ISO' 格式)
const date4 = new Date('2023-10-01T12:30:45');
const formattedDate4 = format(date4, 'ISO');
console.log(formattedDate4); // Outputs: '2023-10-01T16:30:45.000Z' (输出: '2023-10-01T16:30:45.000Z')

get()

get(date, unit): number

定义于: dist/_internal/getOrSet.d.ts:42

Retrieves the value of a specified time unit for a given date. 获取给定日期的指定时间单位的值。

参数

date

Date

The date from which to retrieve the time unit value. (要从中获取时间单位值的日期。)

unit

The unit of time to retrieve (e.g., 'year', 'month', 'day', 'hour', 'minute', 'second', 'millisecond'). (要获取的时间单位，例如 'year'、'month'、'day'、'hour'、'minute'、'second'、'millisecond'。)

number

The value of the specified time unit. (指定时间单位的值。)

示例

// Getting the year of a date (获取日期的年份)
const date = new Date('2023-10-01');
const year = get(date, 'year');
console.log(year); // Outputs: 2023 (输出: 2023)

// Getting the month of a date (获取日期的月份)
const month = get(date, 'month');
console.log(month); // Outputs: 9 (输出: 9，注意月份是从0开始的)

// Getting the day of a date (获取日期的天数)
const day = get(date, 'day');
console.log(day); // Outputs: 1 (输出: 1)

// Getting the hour of a date (获取日期的小时)
const hour = get(date, 'hour');
console.log(hour); // Outputs: 0 (输出: 0)

// Getting the minute of a date (获取日期的分钟)
const minute = get(date, 'minute');
console.log(minute); // Outputs: 0 (输出: 0)

// Getting the second of a date (获取日期的秒数)
const second = get(date, 'second');
console.log(second); // Outputs: 0 (输出: 0)

// Getting the millisecond of a date (获取日期的毫秒数)
const millisecond = get(date, 'millisecond');
console.log(millisecond); // Outputs: 0 (输出: 0)

isAfter()

isAfter(date, input, unit?): boolean

定义于: dist/isAfter.d.ts:56

Checks if a date is after another date or a specified time unit. 检查一个日期是否在另一个日期或指定的时间单位之后。

参数

date

Date

The date to compare. (要比较的日期。)

input

The date or time unit to compare against. (要比较的日期或时间单位。)

unit?

The unit of time to compare (e.g., 'year', 'month', 'day', 'hour', 'minute', 'second', 'millisecond'). (要比较的时间单位，例如 'year'、'month'、'day'、'hour'、'minute'、'second'、'millisecond'。)

boolean

A boolean indicating whether the first date is after the second date or time unit. (布尔值，表示第一个日期是否在第二个日期或时间单位之后。)

示例

// Checking if a date is after another date (检查一个日期是否在另一个日期之后)
const date1 = new Date('2023-10-01');
const date2 = new Date('2023-09-01');
const isAfterDate = isAfter(date1, date2, 'day');
console.log(isAfterDate); // Outputs: true (输出: true)

// Checking if a date is after a specific year (检查一个日期是否在特定年份之后)
const date3 = new Date('2024-01-01');
const isAfterYear = isAfter(date3, 2023, 'year');
console.log(isAfterYear); // Outputs: true (输出: true)

// Checking if a date is after a specific month (检查一个日期是否在特定月份之后)
const date4 = new Date('2023-11-01');
const isAfterMonth = isAfter(date4, '2023-10', 'month');
console.log(isAfterMonth); // Outputs: true (输出: true)

// Checking if a date is after a specific day (检查一个日期是否在特定天数之后)
const date5 = new Date('2023-10-02');
const isAfterDay = isAfter(date5, '2023-10-01', 'day');
console.log(isAfterDay); // Outputs: true (输出: true)

// Checking if a date is after a specific hour (检查一个日期是否在特定小时之后)
const date6 = new Date('2023-10-01T13:00:00');
const isAfterHour = isAfter(date6, '2023-10-01T12:00:00', 'hour');
console.log(isAfterHour); // Outputs: true (输出: true)

// Checking if a date is after a specific minute (检查一个日期是否在特定分钟之后)
const date7 = new Date('2023-10-01T12:01:00');
const isAfterMinute = isAfter(date7, '2023-10-01T12:00:00', 'minute');
console.log(isAfterMinute); // Outputs: true (输出: true)

// Checking if a date is after a specific second (检查一个日期是否在特定秒数之后)
const date8 = new Date('2023-10-01T12:00:01');
const isAfterSecond = isAfter(date8, '2023-10-01T12:00:00', 'second');
console.log(isAfterSecond); // Outputs: true (输出: true)

// Checking if a date is after a specific millisecond (检查一个日期是否在特定毫秒数之后)
const date9 = new Date('2023-10-01T12:00:00.500');
const isAfterMillisecond = isAfter(date9, '2023-10-01T12:00:00.000', 'millisecond');
console.log(isAfterMillisecond); // Outputs: true (输出: true)

isBefore()

isBefore(date, input, unit?): boolean

定义于: dist/isBefore.d.ts:56

Checks if a date is before another date or a specified time unit. 检查一个日期是否在另一个日期或指定的时间单位之前。

参数

date

Date

The date to compare. (要比较的日期。)

input

The date or time unit to compare against. (要比较的日期或时间单位。)

unit?

boolean

A boolean indicating whether the first date is before the second date or time unit. (布尔值，表示第一个日期是否在第二个日期或时间单位之前。)

示例

// Checking if a date is before another date (检查一个日期是否在另一个日期之前)
const date1 = new Date('2023-09-01');
const date2 = new Date('2023-10-01');
const isBeforeDate = isBefore(date1, date2, 'day');
console.log(isBeforeDate); // Outputs: true (输出: true)

// Checking if a date is before a specific year (检查一个日期是否在特定年份之前)
const date3 = new Date('2022-12-31');
const isBeforeYear = isBefore(date3, 2023, 'year');
console.log(isBeforeYear); // Outputs: true (输出: true)

// Checking if a date is before a specific month (检查一个日期是否在特定月份之前)
const date4 = new Date('2023-09-01');
const isBeforeMonth = isBefore(date4, '2023-10', 'month');
console.log(isBeforeMonth); // Outputs: true (输出: true)

// Checking if a date is before a specific day (检查一个日期是否在特定天数之前)
const date5 = new Date('2023-10-01');
const isBeforeDay = isBefore(date5, '2023-10-02', 'day');
console.log(isBeforeDay); // Outputs: true (输出: true)

// Checking if a date is before a specific hour (检查一个日期是否在特定小时之前)
const date6 = new Date('2023-10-01T12:00:00');
const isBeforeHour = isBefore(date6, '2023-10-01T13:00:00', 'hour');
console.log(isBeforeHour); // Outputs: true (输出: true)

// Checking if a date is before a specific minute (检查一个日期是否在特定分钟之前)
const date7 = new Date('2023-10-01T12:00:00');
const isBeforeMinute = isBefore(date7, '2023-10-01T12:01:00', 'minute');
console.log(isBeforeMinute); // Outputs: true (输出: true)

// Checking if a date is before a specific second (检查一个日期是否在特定秒数之前)
const date8 = new Date('2023-10-01T12:00:00');
const isBeforeSecond = isBefore(date8, '2023-10-01T12:00:01', 'second');
console.log(isBeforeSecond); // Outputs: true (输出: true)

// Checking if a date is before a specific millisecond (检查一个日期是否在特定毫秒数之前)
const date9 = new Date('2023-10-01T12:00:00.000');
const isBeforeMillisecond = isBefore(date9, '2023-10-01T12:00:00.500', 'millisecond');
console.log(isBeforeMillisecond); // Outputs: true (输出: true)

isBetween()

isBetween(date, from, to, unit?, inclusivity?): boolean

定义于: dist/isBetween.d.ts:72

Checks if a date is between two other dates or specified time units. 检查一个日期是否在两个其他日期或指定的时间单位之间。

参数

date

Date

The date to check. (要检查的日期。)

from

The start date or time unit. (起始日期或时间单位。)

to

The end date or time unit. (结束日期或时间单位。)

unit?

inclusivity?

string

A string indicating whether the comparison is inclusive or exclusive. (表示比较是否包含边界的字符串。) - '()' means exclusive (不包含边界) (默认值) - '[)' means inclusive on the start, exclusive on the end (包含起始边界，不包含结束边界) - '(]' means exclusive on the start, inclusive on the end (不包含起始边界，包含结束边界) - '[]' means inclusive (包含边界)

boolean

A boolean indicating whether the date is between the two specified dates or time units. (布尔值，表示日期是否在两个指定的日期或时间单位之间。)

示例

// Checking if a date is between two dates (检查一个日期是否在两个日期之间)
const date = new Date('2023-10-01');
const from = new Date('2023-09-01');
const to = new Date('2023-11-01');
const isBetweenDates = isBetween(date, from, to, 'day');
console.log(isBetweenDates); // Outputs: true (输出: true)

// Checking if a date is between two years (检查一个日期是否在两个年份之间)
const date2 = new Date('2023-01-01');
const isBetweenYears = isBetween(date2, 2022, 2024, 'year');
console.log(isBetweenYears); // Outputs: true (输出: true)

// Checking if a date is between two months (检查一个日期是否在两个月份之间)
const date3 = new Date('2023-10-01');
const isBetweenMonths = isBetween(date3, '2023-09', '2023-11', 'month');
console.log(isBetweenMonths); // Outputs: true (输出: true)

// Checking if a date is between two days (检查一个日期是否在两个天数之间)
const date4 = new Date('2023-10-02');
const isBetweenDays = isBetween(date4, '2023-10-01', '2023-10-03', 'day');
console.log(isBetweenDays); // Outputs: true (输出: true)

// Checking if a date is between two hours (检查一个日期是否在两个小时之间)
const date5 = new Date('2023-10-01T12:00:00');
const isBetweenHours = isBetween(date5, '2023-10-01T11:00:00', '2023-10-01T13:00:00', 'hour');
console.log(isBetweenHours); // Outputs: true (输出: true)

// Checking if a date is between two minutes (检查一个日期是否在两个分钟之间)
const date6 = new Date('2023-10-01T12:01:00');
const isBetweenMinutes = isBetween(date6, '2023-10-01T12:00:00', '2023-10-01T12:02:00', 'minute');
console.log(isBetweenMinutes); // Outputs: true (输出: true)

// Checking if a date is between two seconds (检查一个日期是否在两个秒数之间)
const date7 = new Date('2023-10-01T12:00:01');
const isBetweenSeconds = isBetween(date7, '2023-10-01T12:00:00', '2023-10-01T12:00:02', 'second');
console.log(isBetweenSeconds); // Outputs: true (输出: true)

// Checking if a date is between two milliseconds (检查一个日期是否在两个毫秒数之间)
const date8 = new Date('2023-10-01T12:00:00.500');
const isBetweenMilliseconds = isBetween(date8, '2023-10-01T12:00:00.000', '2023-10-01T12:00:00.999', 'millisecond');
console.log(isBetweenMilliseconds); // Outputs: true (输出: true)

// Using different inclusivity options (使用不同的包含选项)
const date9 = new Date('2023-10-01');
const isBetweenInclusive = isBetween(date9, '2023-10-01', '2023-10-01', 'day', '[]');
console.log(isBetweenInclusive); // Outputs: true (输出: true)

const isBetweenExclusive = isBetween(date9, '2023-10-01', '2023-10-01', 'day', '()');
console.log(isBetweenExclusive); // Outputs: false (输出: false)

isLeapYear()

isLeapYear(date): boolean

定义于: dist/isLeapYear.d.ts:20

Checks if a given date is in a leap year. 检查给定的日期是否在闰年。

参数

date

Date

The date to check. (要检查的日期。)

boolean

A boolean indicating whether the given date is in a leap year. (布尔值，表示给定的日期是否在闰年。)

示例

// Checking if a date is in a leap year (检查一个日期是否在闰年)
const date1 = new Date('2024-01-01');
const isLeap = isLeapYear(date1);
console.log(isLeap); // Outputs: true (输出: true)

// Checking if a date is not in a leap year (检查一个日期是否不在闰年)
const date2 = new Date('2023-01-01');
const isNotLeap = isLeapYear(date2);
console.log(isNotLeap); // Outputs: false (输出: false)

isSame()

isSame(date, input, unit?): boolean

定义于: dist/isSame.d.ts:56

Checks if a date is the same as another date or a specified time unit. 检查一个日期是否与另一个日期或指定的时间单位相同。

参数

date

Date

The date to compare. (要比较的日期。)

input

The date or time unit to compare against. (要比较的日期或时间单位。)

unit?

boolean

A boolean indicating whether the first date is the same as the second date or time unit. (布尔值，表示第一个日期是否与第二个日期或时间单位相同。)

示例

// Checking if a date is the same as another date (检查一个日期是否与另一个日期相同)
const date1 = new Date('2023-10-01');
const date2 = new Date('2023-10-01');
const isSameDate = isSame(date1, date2, 'day');
console.log(isSameDate); // Outputs: true (输出: true)

// Checking if a date is the same as a specific year (检查一个日期是否与特定年份相同)
const date3 = new Date('2023-10-01');
const isSameYear = isSame(date3, 2023, 'year');
console.log(isSameYear); // Outputs: true (输出: true)

// Checking if a date is the same as a specific month (检查一个日期是否与特定月份相同)
const date4 = new Date('2023-10-01');
const isSameMonth = isSame(date4, '2023-10', 'month');
console.log(isSameMonth); // Outputs: true (输出: true)

// Checking if a date is the same as a specific day (检查一个日期是否与特定天数相同)
const date5 = new Date('2023-10-01');
const isSameDay = isSame(date5, '2023-10-01', 'day');
console.log(isSameDay); // Outputs: true (输出: true)

// Checking if a date is the same as a specific hour (检查一个日期是否与特定小时相同)
const date6 = new Date('2023-10-01T12:00:00');
const isSameHour = isSame(date6, '2023-10-01T12:00:00', 'hour');
console.log(isSameHour); // Outputs: true (输出: true)

// Checking if a date is the same as a specific minute (检查一个日期是否与特定分钟相同)
const date7 = new Date('2023-10-01T12:00:00');
const isSameMinute = isSame(date7, '2023-10-01T12:00:00', 'minute');
console.log(isSameMinute); // Outputs: true (输出: true)

// Checking if a date is the same as a specific second (检查一个日期是否与特定秒数相同)
const date8 = new Date('2023-10-01T12:00:00');
const isSameSecond = isSame(date8, '2023-10-01T12:00:00', 'second');
console.log(isSameSecond); // Outputs: true (输出: true)

// Checking if a date is the same as a specific millisecond (检查一个日期是否与特定毫秒数相同)
const date9 = new Date('2023-10-01T12:00:00.000');
const isSameMillisecond = isSame(date9, '2023-10-01T12:00:00.000', 'millisecond');
console.log(isSameMillisecond); // Outputs: true (输出: true)

isSameOrAfter()

isSameOrAfter(date, input, unit?): boolean

定义于: dist/isSameOrAfter.d.ts:61

Checks if a date is the same as or after another date or a specified time unit. 检查一个日期是否与另一个日期或指定的时间单位相同或在其之后。

参数

date

Date

The date to compare. (要比较的日期。)

input

The date or time unit to compare against. (要比较的日期或时间单位。)

unit?

boolean

A boolean indicating whether the first date is the same as or after the second date or time unit. (布尔值，表示第一个日期是否与第二个日期或时间单位相同或在其之后。)

示例

// Checking if a date is the same as or after another date (检查一个日期是否与另一个日期相同或在其之后)
const date1 = new Date('2023-10-01');
const date2 = new Date('2023-10-01');
const isSameOrAfterDate = isSameOrAfter(date1, date2, 'day');
console.log(isSameOrAfterDate); // Outputs: true (输出: true)

// Checking if a date is after another date (检查一个日期是否在另一个日期之后)
const date3 = new Date('2023-10-02');
const isSameOrAfterDate2 = isSameOrAfter(date3, date2, 'day');
console.log(isSameOrAfterDate2); // Outputs: true (输出: true)

// Checking if a date is the same as or after a specific year (检查一个日期是否与特定年份相同或在其之后)
const date4 = new Date('2023-01-01');
const isSameOrAfterYear = isSameOrAfter(date4, 2023, 'year');
console.log(isSameOrAfterYear); // Outputs: true (输出: true)

// Checking if a date is the same as or after a specific month (检查一个日期是否与特定月份相同或在其之后)
const date5 = new Date('2023-10-01');
const isSameOrAfterMonth = isSameOrAfter(date5, '2023-10', 'month');
console.log(isSameOrAfterMonth); // Outputs: true (输出: true)

// Checking if a date is the same as or after a specific day (检查一个日期是否与特定天数相同或在其之后)
const date6 = new Date('2023-10-01');
const isSameOrAfterDay = isSameOrAfter(date6, '2023-10-01', 'day');
console.log(isSameOrAfterDay); // Outputs: true (输出: true)

// Checking if a date is the same as or after a specific hour (检查一个日期是否与特定小时相同或在其之后)
const date7 = new Date('2023-10-01T12:00:00');
const isSameOrAfterHour = isSameOrAfter(date7, '2023-10-01T12:00:00', 'hour');
console.log(isSameOrAfterHour); // Outputs: true (输出: true)

// Checking if a date is the same as or after a specific minute (检查一个日期是否与特定分钟相同或在其之后)
const date8 = new Date('2023-10-01T12:00:00');
const isSameOrAfterMinute = isSameOrAfter(date8, '2023-10-01T12:00:00', 'minute');
console.log(isSameOrAfterMinute); // Outputs: true (输出: true)

// Checking if a date is the same as or after a specific second (检查一个日期是否与特定秒数相同或在其之后)
const date9 = new Date('2023-10-01T12:00:00');
const isSameOrAfterSecond = isSameOrAfter(date9, '2023-10-01T12:00:00', 'second');
console.log(isSameOrAfterSecond); // Outputs: true (输出: true)

// Checking if a date is the same as or after a specific millisecond (检查一个日期是否与特定毫秒数相同或在其之后)
const date10 = new Date('2023-10-01T12:00:00.000');
const isSameOrAfterMillisecond = isSameOrAfter(date10, '2023-10-01T12:00:00.000', 'millisecond');
console.log(isSameOrAfterMillisecond); // Outputs: true (输出: true)

isSameOrBefore()

isSameOrBefore(date, input, unit?): boolean

定义于: dist/isSameOrBefore.d.ts:61

Checks if a date is the same as or before another date or a specified time unit. 检查一个日期是否与另一个日期或指定的时间单位相同或在其之前。

参数

date

Date

The date to compare. (要比较的日期。)

input

The date or time unit to compare against. (要比较的日期或时间单位。)

unit?

boolean

A boolean indicating whether the first date is the same as or before the second date or time unit. (布尔值，表示第一个日期是否与第二个日期或时间单位相同或在其之前。)

示例

// Checking if a date is the same as or before another date (检查一个日期是否与另一个日期相同或在其之前)
const date1 = new Date('2023-10-01');
const date2 = new Date('2023-10-01');
const isSameOrBeforeDate = isSameOrBefore(date1, date2, 'day');
console.log(isSameOrBeforeDate); // Outputs: true (输出: true)

// Checking if a date is before another date (检查一个日期是否在另一个日期之前)
const date3 = new Date('2023-09-30');
const isSameOrBeforeDate2 = isSameOrBefore(date3, date2, 'day');
console.log(isSameOrBeforeDate2); // Outputs: true (输出: true)

// Checking if a date is the same as or before a specific year (检查一个日期是否与特定年份相同或在其之前)
const date4 = new Date('2022-12-31');
const isSameOrBeforeYear = isSameOrBefore(date4, 2023, 'year');
console.log(isSameOrBeforeYear); // Outputs: true (输出: true)

// Checking if a date is the same as or before a specific month (检查一个日期是否与特定月份相同或在其之前)
const date5 = new Date('2023-09-30');
const isSameOrBeforeMonth = isSameOrBefore(date5, '2023-10', 'month');
console.log(isSameOrBeforeMonth); // Outputs: true (输出: true)

// Checking if a date is the same as or before a specific day (检查一个日期是否与特定天数相同或在其之前)
const date6 = new Date('2023-10-01');
const isSameOrBeforeDay = isSameOrBefore(date6, '2023-10-01', 'day');
console.log(isSameOrBeforeDay); // Outputs: true (输出: true)

// Checking if a date is the same as or before a specific hour (检查一个日期是否与特定小时相同或在其之前)
const date7 = new Date('2023-10-01T12:00:00');
const isSameOrBeforeHour = isSameOrBefore(date7, '2023-10-01T12:00:00', 'hour');
console.log(isSameOrBeforeHour); // Outputs: true (输出: true)

// Checking if a date is the same as or before a specific minute (检查一个日期是否与特定分钟相同或在其之前)
const date8 = new Date('2023-10-01T12:00:00');
const isSameOrBeforeMinute = isSameOrBefore(date8, '2023-10-01T12:00:00', 'minute');
console.log(isSameOrBeforeMinute); // Outputs: true (输出: true)

// Checking if a date is the same as or before a specific second (检查一个日期是否与特定秒数相同或在其之前)
const date9 = new Date('2023-10-01T12:00:00');
const isSameOrBeforeSecond = isSameOrBefore(date9, '2023-10-01T12:00:00', 'second');
console.log(isSameOrBeforeSecond); // Outputs: true (输出: true)

// Checking if a date is the same as or before a specific millisecond (检查一个日期是否与特定毫秒数相同或在其之前)
const date10 = new Date('2023-10-01T12:00:00.000');
const isSameOrBeforeMillisecond = isSameOrBefore(date10, '2023-10-01T12:00:00.000', 'millisecond');
console.log(isSameOrBeforeMillisecond); // Outputs: true (输出: true)

isValid()

isValid(date): boolean

定义于: dist/isValid.d.ts:20

Checks if a given date is valid. 检查给定的日期是否有效。

参数

date

Date

The date to check. (要检查的日期。)

boolean

A boolean indicating whether the given date is valid. (布尔值，表示给定的日期是否有效。)

示例

// Checking if a date is valid (检查一个日期是否有效)
const date1 = new Date('2023-10-01');
const isValidDate1 = isValid(date1);
console.log(isValidDate1); // Outputs: true (输出: true)

// Checking if an invalid date is valid (检查一个无效的日期是否有效)
const date2 = new Date('invalid-date');
const isValidDate2 = isValid(date2);
console.log(isValidDate2); // Outputs: false (输出: false)

parse()

parse(input, format?): Date

定义于: dist/parse.d.ts:35

Parses a date from various input types. 从各种输入类型中解析日期。

参数

input

The input to parse, which can be a string, number, Date, or array of numbers. (要解析的输入，可以是字符串、数字、Date 对象或数字数组。)

DateInput | { isValid: () => any; }

format?

string

An optional format string that specifies the format of the input string if the input is a string. Or A boolean indicating whether the date should be in UTC. (可选的格式字符串，指定输入字符串的格式，如果输入是字符串。或者是布尔值，表示日期是否应为 UTC。)

Date

A Date object representing the parsed date. (表示解析后日期的 Date 对象。)

示例

// 从字符串中解析日期
const result = parse('20231001123456', 'YYYYMMDDHHmmss');
console.log(result); // 输出: 2023-10-01T12:34:56.000Z

// 从 ISO 8601 字符串中解析日期
const isoResult = parse('2023-10-01T12:34:56Z');
console.log(isoResult); // 输出: 2023-10-01T12:34:56.000Z

// 从数字数组中解析日期
const arrayResult = parse([2023, 9, 1, 12, 34, 56]);
console.log(arrayResult); // 输出: 2023-10-01T12:34:56.000Z

// 从数字中解析日期
const numberResult = parse(1696119296000);
console.log(numberResult); // 输出: 2023-10-01T12:34:56.000Z

// 从 Date 对象中解析日期
const dateResult = parse(new Date('2023-10-01T12:34:56Z'));
console.log(dateResult); // 输出: 2023-10-01T12:34:56.000Z

set()

set(date, unit, val): Date

定义于: dist/_internal/getOrSet.d.ts:85

Sets the value of a specified time unit for a given date. 设置给定日期的指定时间单位的值。

参数

date

Date

The date for which to set the time unit value. (要设置时间单位值的日期。)

unit

The unit of time to set (e.g., 'year', 'month', 'day', 'hour', 'minute', 'second', 'millisecond'). (要设置的时间单位，例如 'year'、'month'、'day'、'hour'、'minute'、'second'、'millisecond'。)

val

number

The value to set for the specified time unit. (要设置的时间单位的值。)

Date

The modified date with the specified time unit set. (设置指定时间单位后修改的日期。)

示例

// Setting the year of a date (设置日期的年份)
const date = new Date('2023-10-01');
const newDate = set(date, 'year', 2024);
console.log(newDate.toISOString()); // Outputs: '2024-10-01T00:00:00.000Z' (输出: '2024-10-01T00:00:00.000Z')

// Setting the month of a date (设置日期的月份)
const newDateWithMonth = set(date, 'month', 11);
console.log(newDateWithMonth.toISOString()); // Outputs: '2024-12-01T00:00:00.000Z' (输出: '2024-12-01T00:00:00.000Z')

// Setting the day of a date (设置日期的天数)
const newDateWithDay = set(date, 'day', 15);
console.log(newDateWithDay.toISOString()); // Outputs: '2024-12-15T00:00:00.000Z' (输出: '2024-12-15T00:00:00.000Z')

// Setting the hour of a date (设置日期的小时)
const newDateWithHour = set(date, 'hour', 12);
console.log(newDateWithHour.toISOString()); // Outputs: '2024-12-15T12:00:00.000Z' (输出: '2024-12-15T12:00:00.000Z')

// Setting the minute of a date (设置日期的分钟)
const newDateWithMinute = set(date, 'minute', 30);
console.log(newDateWithMinute.toISOString()); // Outputs: '2024-12-15T12:30:00.000Z' (输出: '2024-12-15T12:30:00.000Z')

// Setting the second of a date (设置日期的秒数)
const newDateWithSecond = set(date, 'second', 45);
console.log(newDateWithSecond.toISOString()); // Outputs: '2024-12-15T12:30:45.000Z' (输出: '2024-12-15T12:30:45.000Z')

// Setting the millisecond of a date (设置日期的毫秒数)
const newDateWithMillisecond = set(date, 'millisecond', 500);
console.log(newDateWithMillisecond.toISOString()); // Outputs: '2024-12-15T12:30:45.500Z'
(输出: '2024-12-15T12:30:45.500Z')

startOf()

startOf(date, unit): Date

定义于: dist/startOf.d.ts:43

Sets the date to the start of the specified unit of time. 将日期设置为指定时间单位的开始时间。

参数

date

Date

The date to set to the start of the specified unit. (要设置为指定时间单位开始时间的日期。)

unit

The unit of time to set the start of (e.g., 'year', 'month', 'day', 'hour', 'minute', 'second'). (要设置开始时间的时间单位，例如 'year'、'month'、'day'、'hour'、'minute'、'second'。)

Date

A new date object set to the start of the specified unit. (设置为指定时间单位开始时间的新日期对象。)

示例

// Setting the start of the year (设置年份开始时间)
const date1 = new Date('2023-10-01');
const startOfYear = startOf(date1, 'year');
console.log(startOfYear.toISOString()); // Outputs: '2023-01-01T00:00:00.000Z' (输出: '2023-01-01T00:00:00.000Z')

// Setting the start of the month (设置月份开始时间)
const date2 = new Date('2023-10-01');
const startOfMonth = startOf(date2, 'month');
console.log(startOfMonth.toISOString()); // Outputs: '2023-10-01T00:00:00.000Z' (输出: '2023-10-01T00:00:00.000Z')

// Setting the start of the day (设置天数开始时间)
const date3 = new Date('2023-10-01T12:30:45');
const startOfDay = startOf(date3, 'day');
console.log(startOfDay.toISOString()); // Outputs: '2023-10-01T00:00:00.000Z' (输出: '2023-10-01T00:00:00.000Z')

// Setting the start of the hour (设置小时开始时间)
const date4 = new Date('2023-10-01T12:30:45');
const startOfHour = startOf(date4, 'hour');
console.log(startOfHour.toISOString()); // Outputs: '2023-10-01T12:00:00.000Z' (输出: '2023-10-01T12:00:00.000Z')

// Setting the start of the minute (设置分钟开始时间)
const date5 = new Date('2023-10-01T12:30:45');
const startOfMinute = startOf(date5, 'minute');
console.log(startOfMinute.toISOString()); // Outputs: '2023-10-01T12:30:00.000Z' (输出: '2023-10-01T12:30:00.000Z')

// Setting the start of the second (设置秒数开始时间)
const date6 = new Date('2023-10-01T12:30:45.678');
const startOfSecond = startOf(date6, 'second');
console.log(startOfSecond.toISOString()); // Outputs: '2023-10-01T12:30:45.000Z' (输出: '2023-10-01T12:30:45.000Z')

subDays()

subDays(date, days): Date

定义于: dist/subDays.d.ts:14

Subtracts a specified number of days from a date. 从日期中减去指定数量的天数。

参数

date

Date

The date to subtract days from. (要减去天数的日期。)

days

number

The number of days to subtract. (要减去的天数。)

Date

A new date with the subtracted days. (减去天数后的新日期。)

示例

const newDate = subDays(new Date(), 5);
console.log(newDate); // Outputs the date 5 days ago (输出5天前的日期)

subHours()

subHours(date, hours): Date

定义于: dist/subHours.d.ts:15

Subtracts a specified number of hours from a date. 从日期中减去指定数量的小时。

参数

date

Date

The date to subtract hours from. (要从日期中减去的小时数。)

hours

number

The number of hours to subtract. (要减去的小时数。)

Date

A new date with the subtracted hours. (减去小时后的新日期。)

示例

//Subtracting 3 hours from a date (从日期中减去3)
subHours(new Date(2014, 6, 2, 11, 55), 3);
//=> Thu Jul 02 2015 08:55:00

subMilliseconds()

subMilliseconds(date, ms): Date

定义于: dist/subMilliseconds.d.ts:15

Subtracts a specified number of milliseconds from a date. 从日期中减去指定的毫秒数。

参数

date

Date

The date to subtract milliseconds from. (要从中减去毫秒的日期。)

ms

number

The number of milliseconds to subtract. (要减去的毫秒数。)

Date

A new date with the subtracted milliseconds. (减去毫秒后的新日期。)

示例

typescript

// Subtract 500 milliseconds from 10/31/2021 5:45:50 PM
const result = subMilliseconds(new Date(2021, 9, 31, 17, 45, 50, 500), 500);
//=> Thu Oct 31 2021 17:45:49.000

subMinutes()

subMinutes(date, minutes): Date

定义于: dist/subMinutes.d.ts:16

Subtracts a specified number of minutes from a date. 从日期中减去指定数量的分钟。

参数

date

Date

The date to subtract minutes from. (要从日期中减去的日期。)

minutes

number

The number of minutes to subtract. (要减去的分钟数。)

Date

A new date with the subtracted minutes. (减去分钟后的新日期。)

示例

// Subtracting 30 minutes from a date (从日期中减去30分钟)
const date = new Date('2023-10-01T12:00:00Z');
subMinutes(date, 30);
// Returns: 2023-10-01T11:30:00.000Z (返回: 2023-10-01T11:30:00.000Z)

subMonths()

subMonths(date, months): Date

定义于: dist/subMonths.d.ts:16

Subtracts a specified number of months from a date. 从日期中减去指定数量的月份。

参数

date

Date

The date to subtract months from. (要减去月份的日期。)

months

number

The number of months to subtract. (要减去的月份数。)

Date

A new date with the subtracted months. (减去月份后的新日期。)

示例

//Subtracting 2 months from a date (从日期中减去2)
const date = new Date('2023-10-31T12:00:00Z');
subMonths(date, 2);
// Returns: 2023-08-31T12:00:00Z (返回: 2023-08-31T12:00:00Z)

subSeconds()

subSeconds(date, seconds): Date

定义于: dist/subSeconds.d.ts:15

Subtracts a specified number of seconds from a date. 从日期中减去指定数量的秒。

参数

date

Date

The date to subtract seconds from. (要从日期中减去秒的日期。)

seconds

number

The number of seconds to subtract. (要减去的秒数。)

Date

A new date with the subtracted seconds. (减去秒后的新日期。)

示例

// Subtracting 30 seconds from a date (从日期中减)
subSeconds(new Date(2014, 1, 28, 0, 30, 40), 30);
//=> Thu Feb 27 2014 23:59:10

subtract()

调用签名

subtract(date, input): Date

定义于: dist/subtract.d.ts:2

参数

date

Date

input

number | DateAddingObject

Date

调用签名

subtract(date, num, unit): Date

定义于: dist/subtract.d.ts:3

参数

date

Date

num

number

unit