Interface DateTimeFns

interface DateTimeFns {
    addTime: AddTime;
    dateDifference: DateDifference;
    dateToString: DateToString;
    day: Day;
    endOfMonth: EndOfMonth;
    hour: Hour;
    minute: Minute;
    month: Month;
    second: Second;
    stringToDate: StringToDate;
    subtractTime: SubtractTime;
    week: Week;
    year: Year;
}

Index

Properties

addTime dateDifference dateToString day endOfMonth hour minute month second stringToDate subtractTime week year

Properties

addTime

addTime: AddTime

Adds days, hours, minutes, and/or seconds to the input Date/Time, Date, or Due Date.

Param: input

Date/Time, Date, or Due Date If the input is a Date or Due Date, the transform creates a full date/time value using time values of hour 0, minute 0, and second 0.

Param: duration

Object specifying any of days, hours, minutes, seconds. Omitted units default to 0.

Returns

Date/Time - Transformed Date/Time after adding the specified Duration

Example

addTime(new Date('2021-05-02 09:10:12'), { days: 2, hours: 3 }) // → '2021-05-04 12:10:12'

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.

dateDifference

dateDifference: DateDifference

Return a duration of time between the input date and the parameter date time.

Param: input

DateTime/DueDate/Date

Param: dateTime

Date/Time, Due Date or Date to calculate difference between the given input.

Returns

Duration- Returns the duration of time added to epoch time (1970-01-01) in Date/Time format, representing the difference between two input dates.

Example

dateDifference('2021-05-02 09:10:12', '2021-04-07 06:02:23') // → '1970-01-26 03:07:49'

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.

dateToString

dateToString: DateToString

Converts a Date/Time, Date, or Due Date to a formatted string.

Param: input

Date/Time, Date, or Due Date - If the input is a Date or Due Date, the transform creates a full date/time value using time values of hour 0, minute 0, and second 0.

Param: format

Date/time or date format of the output String. Predefined format choice value. Use Custom for custom

Param: customFormat

Required Valid date/time or date format represented as a String. Required only if Custom Format is selected as the Date Format.

Returns

String - String formatted as specified in Output Date Format

Example

dateToString('1996-01-16 19:56:10', 'MM/dd/yy') // → '01/16/96'

Note

Runtime Date/Time values are not localized and appear in the UTC (Coordinated Universal Time) time zone.

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.

Note

Common Date Formats

|--------------------|--------|----------------------------|

Format Type	Format	Example
Year	y	1970, 1971, ... 2004, 2005
Month	MM	01, 02, ... 11, 12
Month Name	MMM	Jan, Feb, ... Nov, Dec
Day in Month	dd	01, 02, ... 30, 31
Day Name	EEE	Sun, Mon, ... Fri, Sat
Hour (12-hour)	h	1, 2, ... 11, 12
Hour (24-hour)	HH	00, 01, ... 22, 23
Minute in Hour	mm	00, 01, ... 58, 59
Second in Minute	ss	00, 01, ... 58, 59
Escape Character	'	'at' h:mm a = at 1:30 PM
(Single Quote)
--------------------	--------	----------------------------

day

day: Day

Returns the day of the month for a specific date and time.

Param: input

Date/Time value.

Returns

Integer - returns day component of the specified input.

Example

day('2021-11-20 13:06:12') // → 20

Note

Runtime Date/Time values are not localized and appear in the UTC (Coordinated Universal Time) time zone.

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.

endOfMonth

endOfMonth: EndOfMonth

Returns a date representing the last day of a month which falls a specified number of months before or after specified date.

Param: input

Base date.

Param: offset

Number of months to be added to specified date.

Returns

Date/Time - Returns a date representing the last day of a month which falls a specified number of months before or after specified date.

Example

endOfMonth('2021-05-15', 1) // → '2021-06-30 00:00:00'

Note

Runtime Date/Time values are not localized and appear in the UTC (Coordinated Universal Time) time zone.

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.

hour

hour: Hour

Returns the hour component of a specific date and time.

Param: input

Date/Time value.

Returns

Integer - Hour component of the specified input.

Example

hour('2021-11-20 13:06:12') // → 13

Note

Runtime Date/Time values are not localized and appear in the UTC (Coordinated Universal Time) time zone.

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.

minute

minute: Minute

Returns the minute component of a specific date and time.

Param: input

Date/Time value.

Returns

Integer - Minute component of the specified input.

Example

minute('2021-11-20 13:06:12') // → 6

Note

Runtime Date/Time values are not localized and appear in the UTC (Coordinated Universal Time) time zone.

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.

month

month: Month

Returns the month component of a specific date and time.

Param: input

Date/Time value.

Returns

Integer - Month component of the specified input.

Example

month('2021-11-20 13:06:12') // → 11

Note

Runtime Date/Time values are not localized and appear in the UTC (Coordinated Universal Time) time zone.

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.

second

second: Second

Returns the seconds component of a specific date and time.

Param: input

Date/Time value.

Returns

Integer - Seconds component of the specified input.

Example

second('2021-11-20 13:06:12') // → 12

Note

Runtime Date/Time values are not localized and appear in the UTC (Coordinated Universal Time) time zone.

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.

stringToDate

stringToDate: StringToDate

Converts the input String to a Date/Time.

Param: input

String formatted as specified in Input Date Format

Param: format

Date/time or date format of the input String. Predefined format choice value. Use Custom for custom

Param: customFormat

Required Valid date/time or date format represented as a String. Required only if Custom Format is selected as the Date Format.

Returns

Date/Time - If the date/time value for the Custom Format is incomplete, the transform creates a full date/time value using default dates and times. The transform defaults to the current year, the current month, day 1 of a month, hour 0, minute 0, and second 0.

Example

stringToDate('1995-11-20', 'yyyy-MM-dd') // → '1995-11-20 00:00:00'

Note

Runtime Date/Time values are not localized and appear in the UTC (Coordinated Universal Time) time zone.

Note

If input data type is not String, the data is not transformed at runtime.

Note

Common Date Formats

|--------------------|--------|----------------------------|

Format Type	Format	Example
Year	y	1970, 1971, ... 2004, 2005
Month	MM	01, 02, ... 11, 12
Month Name	MMM	Jan, Feb, ... Nov, Dec
Day in Month	dd	01, 02, ... 30, 31
Day Name	EEE	Sun, Mon, ... Fri, Sat
Hour (12-hour)	h	1, 2, ... 11, 12
Hour (24-hour)	HH	00, 01, ... 22, 23
Minute in Hour	mm	00, 01, ... 58, 59
Second in Minute	ss	00, 01, ... 58, 59
Escape Character	'	'at' h:mm a = at 1:30 PM
(Single Quote)
--------------------	--------	----------------------------

subtractTime

subtractTime: SubtractTime

Subtracts days, hours, minutes, and/or seconds from the input Date/Time, Date, or Due Date.

Param: input

Date/Time, Date, or Due Date - If the date/time value for the Custom Format is incomplete, the transform creates a full date/time value using default dates and times.

Param: duration

Object specifying any of days, hours, minutes, seconds. Omitted units default to 0.

Returns

Date/Time - Transformed Date/Time after subtracting the specified Duration

Example

subtractTime(new Date('2021-05-04 12:10:12'), { days: 2, hours: 3 }) // → '2021-05-02 09:10:12'

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.

week

week: Week

Returns the week of the year that a specific date falls on.

Param: input

Date/Time value.

Returns

Integer - Week of the year that a specific date falls on

Example

week('2021-04-07 12:01:12') // → 15

Note

Runtime Date/Time values are not localized and appear in the UTC (Coordinated Universal Time) time zone.

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.

year

year: Year

Returns the year component of a specific date and time.

Param: input

Date/Time value.

Returns

Integer - Year component of the specified input

Example

year('2021-11-20 13:06:12') // → 2021

Note

Runtime Date/Time values are not localized and appear in the UTC (Coordinated Universal Time) time zone.

Note

If input data type is not Date/Time, Date, or Due Date, the data is not transformed at runtime.