Module Date

Returns a date, that is the given date plus the given amount of unit.

It's safe, the given date is not changed.

Possible time units are : "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" |"years"

throws

example

// returns the date 2 days in the future
JMap.Util.Date.add(new Date(), 2, "days")

// returns the date 2 seconds in the future
JMap.Util.Date.add(new Date(), 2, "seconds")

Returns a formatted string from a date.

throws

if date is not a Date object, or ISO string, or timestamp number

example

// returns the current date as a string, according to the current user locale
JMap.Util.Date.format(new Date())

// returns the current date as a string, with time, according to the current user locale
JMap.Util.Date.format(new Date(), {
 displayTime: true
})

Returns in the user's locale language, the time that will pass, or passed from now for the given date.

throws

if date is not a Date object, or ISO string, or timestamp number

example

// returns in the user's locale language, the time that will pass, or passed from now for the given date
JMap.Util.Date.formatDistanceToNow(new Date())

Returns the date for the given input.

example

// returns a date object for the given timestamp
JMap.Util.Date.getDate(1631879544000)

// returns a date object for the given ISO string
JMap.Util.Date.getDate("2012-09-27")

Returns the format for date-fns library.

example

// returns the format for date-fns library without datetime
JMap.Util.Date.getDateFnsLocale()

// returns the format for date-fns library without datetime
JMap.Util.Date.getDateFnsLocale(true)

Returns a date corresponding to the given ISO-8601 date string.

throws

example

// returns a date corresponding to the given ISO-8601 date string.
JMap.Util.Date.getDateFromISOString()

Returns true if the current user locale use AM-PM format, else false.

example

// returns true if the current user locale use AM-PM format, else false
JMap.Util.Date.is12HoursTimeFormat()

Returns true if the first date is after the second date.

throws

if dates are not Date object, or ISO string, or timestamp number

example

// returns in the user's locale language, the time that will pass, or passed from now for the given date
const firstDate = new Date()
setTimeout(() => {
 const secondDate = new Date()
 // will return false (time is not checked)
 JMap.Util.Date.isAfter(secondDate, firstDate)

 // will return true (because also check the time)
 JMap.Util.Date.isAfter(secondDate, firstDate, true)
}, 1000)

Returns true if the first date is before the second date.

throws

if dates are not Date object, or ISO string, or timestamp number

example

// returns in the user's locale language, the time that will pass, or passed from now for the given date
const firstDate = new Date()
setTimeout(() => {
 const secondDate = new Date()
 // will return false
 JMap.Util.Date.isBefore(firstDate, secondDate)

 // will return true (because also check the time)
 JMap.Util.Date.isBefore(firstDate, secondDate, true)
}, 1000)

Returns a date, that is the given date minus the given amount of unit.

It's safe, the given date is not changed.

Possible time units are : "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" |"years"

throws

example

// returns the date 2 days in the past
JMap.Util.Date.substract(new Date(), 2, "days")

// returns the date 2 seconds in the past
JMap.Util.Date.substract(new Date(), 2, "seconds")