Class DateTime

constructor

• new DateTime(date?): DateTime

• Constructor

  Parameters

  • Optional date: string | number | Date

    Can be a date object, a unix timestamp or date string (see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format)

  Returns DateTime

Readonly date

timezone

Static dayMap

Static dayNames

Static firstWeekDay

Static monthNames

add

• add(dateInterval): DateTime

• Add a date interval

  Parameters

  • dateInterval: DateInterval

  Returns DateTime

addDays

• addDays(days): DateTime

• Parameters

  • days: number

  Returns DateTime

addHours

• addHours(hours): DateTime

• Parameters

  • hours: number

  Returns DateTime

addMinutes

• addMinutes(minutes): DateTime

• Parameters

  • minutes: number

  Returns DateTime

addMonths

• addMonths(months): DateTime

• Parameters

  • months: number

  Returns DateTime

addSeconds

• addSeconds(seconds): DateTime

• Parameters

  • seconds: number

  Returns DateTime

addYears

• addYears(years): DateTime

• Parameters

  • years: number

  Returns DateTime

clone

• clone(): DateTime

• Create a copy of this object without reference

  Returns DateTime

compare

• compare(date): number

• Compare with given date

  Returns:

  • -1 if this interval is smaller than the other
  • 0 if intervals are equal
  • 1 if this interval is greater than the other

  Parameters

  • date: DateTime

  Returns number

  number

diff

• diff(end): DateInterval

• Calculate difference between this and the given date

  Parameters

  • end: DateTime

  Returns DateInterval

format

• format(format): string

• Format the date into a string

  You can use the following characters. You can escape a character with a \ to output it as given.

  d - The day of the month (from 01 to 31) D - A textual representation of a day (three letters) j - The day of the month without leading zeros (1 to 31) l (lowercase 'L') - A full textual representation of a day N - The ISO-8601 numeric representation of a day (1 for Monday, 7 for Sunday) S - The English ordinal suffix for the day of the month (2 characters st, nd, rd or th. Works well with j) w - A numeric representation of the day (0 for Sunday, 6 for Saturday) z - The day of the year (from 0 through 365) W - The ISO-8601 week number of year (weeks starting on Monday) F - A full textual representation of a month (January through December) m - A numeric representation of a month (from 01 to 12) M - A short textual representation of a month (three letters) n - A numeric representation of a month, without leading zeros (1 to 12) t - The number of days in the given month L - Whether it's a leap year (1 if it is a leap year, 0 otherwise) o - The ISO-8601 year number Y - A four digit representation of a year y - A two digit representation of a year a - Lowercase am or pm A - Uppercase AM or PM B - Swatch Internet time (000 to 999) g - 12-hour format of an hour (1 to 12) G - 24-hour format of an hour (0 to 23) h - 12-hour format of an hour (01 to 12) H - 24-hour format of an hour (00 to 23) i - Minutes with leading zeros (00 to 59) s - Seconds, with leading zeros (00 to 59) u - Microseconds (added in PHP 5.2.2) e - The timezone identifier (Examples: UTC, GMT, Atlantic/Azores) I (capital i) - Whether the date is in daylights savings time (1 if Daylight Savings Time, 0 otherwise) O - Difference to Greenwich time (GMT) in hours (Example: +0100) P - Difference to Greenwich time (GMT) in hours:minutes (added in PHP 5.1.3) T - Timezone abbreviations (Examples: EST, MDT) Z - Timezone offset in seconds. The offset for timezones west of UTC is negative (-43200 to 50400) c - The ISO-8601 date (e.g. 2013-05-05T16:34:42+00:00) r - The RFC 2822 formatted date (e.g. Fri, 12 Apr 2013 12:01:05 +0200) U - The seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)

  Parameters

  • format: string

  Returns string

getDate

• getDate(): number

• Returns number

getDay

• getDay(): number

• 0 for sunday, 1 for monday, 2 for tuesday

  Returns number

getDayOfYear

• getDayOfYear(): number

• Get the numeric day number of the year

  Returns number

getDaysInMonth

• getDaysInMonth(): number

• Get the number of days in the current month

  Returns number

getGMTOffset

• getGMTOffset(colon?): string

• Parameters

  • colon: "" | ":" = ":"

  Returns string

getHours

• getHours(): number

• Returns number

getMilliseconds

• getMilliseconds(): number

• Returns number

getMinuteOfDay

• getMinuteOfDay(): number

• Returns number

getMinutes

• getMinutes(): number

• Returns number

getMonth

• getMonth(): number

• Gets the month. Unlike JS it's 1 - 12

  Returns number

getMonthDay

• getMonthDay(): number

• Returns number

getSeconds

• getSeconds(): number

• Returns number

getTime

• getTime(): number

• Gets the time value in milliseconds.

  Returns number

getTimezoneOffset

• getTimezoneOffset(): number

• User timezone offset in minutes

  eg.

  const browser = new Date("2021-10-21T16:00:00+00:00");
  
  const amsterdam = utc.toTimezone("europe/amsterdam");
  
  console.log(amsterdam.getUserTimezoneOffset()); // 120 (in daylight savings time)
  Copy

  Returns number

getWeekDay

• getWeekDay(): number

• Like getDay but take firstWeekDay of the week into account 0 = first day of the week, 6 = last day

  Returns number

getWeekOfYear

• getWeekOfYear(): number

• The ISO-8601 week number of year (weeks starting on Monday)

  Returns number

getYear

• getYear(): number

• Get the year

  Returns number

isLeapYear

• isLeapYear(): boolean

• Check if current date is in a leap year

  Returns boolean

setDate

• setDate(date): DateTime

• Parameters

  • date: number

  Returns DateTime

setDay

• setDay(day): DateTime

• Jump to day in current week

  Parameters

  • day: number

  Returns DateTime

setHours

• setHours(hours, min?, sec?, ms?): DateTime

• Sets the hour value in the Date object

  Parameters

  • hours: number

    A numeric value equal to the hours value.

  • min: number = ...

  • sec: number = ...

    A numeric value equal to the seconds value.

  • ms: number = ...

  Returns DateTime

  Params

  min A numeric value equal to the minutes value.

setMilliseconds

• setMilliseconds(ms): DateTime

• Parameters

  • ms: number

  Returns DateTime

setMinutes

• setMinutes(min): DateTime

• Parameters

  • min: number

  Returns DateTime

setMonth

• setMonth(month): DateTime

• Parameters

  • month: number

  Returns DateTime

setMonthDay

• setMonthDay(date): DateTime

• Parameters

  • date: number

  Returns DateTime

setSeconds

• setSeconds(s): DateTime

• Parameters

  • s: number

  Returns DateTime

setWeekDay

• setWeekDay(day): DateTime

• Parameters

  • day: number

  Returns DateTime

setYear

• setYear(year): DateTime

• Parameters

  • year: number

  Returns DateTime

toTimezone

• toTimezone<T>(timezone): DateTime

• Convert date to timezone

  Type Parameters

  • T extends string

  Parameters

  • timezone: Timezone

    eg. europe/amsterdam

  Returns DateTime

  Example

  On computer with Amsterdam timezone

  const browser = new Date("2021-10-21T16:00:00+00:00");
  console.log(browser.format("c"), browser.getTimeZone());
  const riga = browser.toTimezone("europe/riga");
  
  console.log(riga.format("c"), riga.getTimeZone());
  
  const utc = riga.toUTC();
  
  console.log(utc.format("c"), utc.getTimeZone());
  
  Copy

  Output: 2021-10-21T18:00:00+02:00 Europe/Amsterdam 2021-10-21T19:00:00+03:00 europe/riga 2021-10-21T16:00:00+00:00 UTC

toUTC

• toUTC(): DateTime

• Convert to UTC timezone

  Returns DateTime

Static createFromFormat

• createFromFormat(dateStr, format?, timezone?): undefined | DateTime

• Create date by given format. See DateTime.format. Supports: Y, y, m, n, d, j, H, h, G, g, i, s, a, A

  Parameters

  • dateStr: string

  • format: string = "c"

  • Optional timezone: Timezone

  Returns undefined | DateTime

  Example

  const date = Date.createFromFormat("2021-10-21 21:09", "Y-m-d H:i"));
  
  const date = console.log(Date.createFromFormat("10/12/2021 9:09am", "m/d/Y g:ia", "America/New_York));
  Copy

Static staticInit

• staticInit(lang): void

• Parameters

  • lang: string

  Returns void