Skip to main content

@rtorcato/js-common / date

date

Functions​

today()​

today(): string

Defined in: date/index.ts:18

Returns today's date as a YYYY-MM-DD string.

Example​

today() // '2026-08-11'

Returns​

string

parseDate()​

parseDate(dateStr): Date

Defined in: date/index.ts:31

Returns a Date object from a YYYY-MM-DD string (parsed as local time).

Example​

parseDate('2026-08-11') // Date for 2026-08-11 00:00:00 local time
parseDate('2026-08-11').getFullYear() // 2026

Parameters​

dateStr​

string

Returns​

Date

formatDate()​

formatDate(date): string

Defined in: date/index.ts:43

Formats a Date object as YYYY-MM-DD (UTC).

Example​

formatDate(new Date('2026-08-11T23:30:00Z')) // '2026-08-11'

Parameters​

date​

Date

Returns​

string

daysBetween()​

daysBetween(date1, date2): number

Defined in: date/index.ts:50

Returns the difference in days between two dates (date2 - date1).

Parameters​

date1​

string | Date

date2​

string | Date

Returns​

number

diffInHours()​

diffInHours(date1, date2): number

Defined in: date/index.ts:57

Returns the difference in hours between two dates (date2 - date1).

Parameters​

date1​

string | Date

date2​

string | Date

Returns​

number

diffInMinutes()​

diffInMinutes(date1, date2): number

Defined in: date/index.ts:64

Returns the difference in minutes between two dates (date2 - date1).

Parameters​

date1​

string | Date

date2​

string | Date

Returns​

number

isLeapYear()​

isLeapYear(year): boolean

Defined in: date/index.ts:71

Checks if a year is a leap year.

Parameters​

year​

number | Date

Returns​

boolean

addDays()​

addDays(date, days): Date

Defined in: date/index.ts:79

Adds days to a date and returns a new Date object.

Parameters​

date​

string | Date

days​

number

Returns​

Date

subDays()​

subDays(date, days): Date

Defined in: date/index.ts:88

Subtracts days from a date and returns a new Date object.

Parameters​

date​

string | Date

days​

number

Returns​

Date

addMonths()​

addMonths(date, months): Date

Defined in: date/index.ts:95

Adds months to a date and returns a new Date object.

Parameters​

date​

string | Date

months​

number

Returns​

Date

getDayOfWeek()​

getDayOfWeek(date): number

Defined in: date/index.ts:104

Returns the day of the week for a date (0=Sunday, 6=Saturday).

Parameters​

date​

string | Date

Returns​

number

startOfDay()​

startOfDay(date): Date

Defined in: date/index.ts:111

Returns a new Date set to the start of the day (00:00:00.000) in local time.

Parameters​

date​

string | Date

Returns​

Date

endOfDay()​

endOfDay(date): Date

Defined in: date/index.ts:120

Returns a new Date set to the end of the day (23:59:59.999) in local time.

Parameters​

date​

string | Date

Returns​

Date

isWeekend()​

isWeekend(date): boolean

Defined in: date/index.ts:129

Returns true if the date falls on Saturday or Sunday.

Parameters​

date​

string | Date

Returns​

boolean

isSameDay()​

isSameDay(date1, date2): boolean

Defined in: date/index.ts:137

Returns true if the two dates fall on the same calendar day (local time).

Parameters​

date1​

string | Date

date2​

string | Date

Returns​

boolean

isToday()​

isToday(date): boolean

Defined in: date/index.ts:150

Returns true if the date is today (local time).

Parameters​

date​

string | Date

Returns​

boolean

formatRelative()​

formatRelative(date, now?): string

Defined in: date/index.ts:158

Formats a date as a short relative string: "today", "yesterday", "tomorrow", "N days ago", or "in N days". Compared against now (defaults to current time).

Parameters​

date​

string | Date

now?​

Date = ...

Returns​

string