|
| 1 | +# Introduction |
| 2 | + |
| 3 | +JavaScript has a built-in object `Date` which stores date and time, and provides methods for their management. |
| 4 | + |
| 5 | +<!-- prettier-ignore --> |
| 6 | +~~~exercism/caution |
| 7 | +It was based on Java's `java.util.Date` class, which was replaced in the early 2010s, but for backwards compatibility, JavaScript's `Date` sticks around. |
| 8 | +
|
| 9 | +Because of how hard it is to work with Dates in general and because of how bad or non-existing timezone handling is, many libraries exist such as `moment.js`, `day.js`, `date-fns` and `luxon`. |
| 10 | +None of these are available on Exercism. |
| 11 | +
|
| 12 | +In your own projects, do not use a deprecated / unmaintained package such as `moment.js` but rely on more modern alternatives like `luxon`, or the not yet widely available [Temporal][mdn-temporal]. |
| 13 | +This exercise focusses on `Date`, which will remain relevant until the end of JavaScript. |
| 14 | +~~~ |
| 15 | + |
| 16 | +## Creation |
| 17 | + |
| 18 | +A `Date` object in an instance of the `Date` class. |
| 19 | +It can be created without passing any arguments to the constructor function. |
| 20 | +This results in a `Date` object that represents the current date and time: |
| 21 | + |
| 22 | +```javascript |
| 23 | +const now = new Date(); |
| 24 | +// => Thu Apr 14 2022 11:46:08 GMT+0530 (India Standard Time) |
| 25 | +// Shows current day, date and time (in your time zone). |
| 26 | +``` |
| 27 | + |
| 28 | +### Unix timestamp (number) |
| 29 | + |
| 30 | +If a number is passed in, this will be interpreted as a `timestamp`. |
| 31 | +A timestamp is an integer number representing the number of **milliseconds** that has passed since **1 January 1970 [UTC][defn-utc]+0**. |
| 32 | + |
| 33 | +```javascript |
| 34 | +const epoch = new Date(0); |
| 35 | +// Thu Jan 01 1970 01:00:00 GMT+0100 (Central European Standard Time) |
| 36 | + |
| 37 | +const another = new Date(1749508766627); |
| 38 | +// Tue Jun 10 2025 00:39:26 GMT+0200 (Central European Summer Time) |
| 39 | +``` |
| 40 | + |
| 41 | +One may expect `new Date(0)` to generate the "earliest" date object, but JavaScript will convert the date to your local timezone, which means that only those around [GMT / with an UTC+0][defn-gmt] timezone will actually get the [Unix epoch][defn-unix-epoch] value. |
| 42 | + |
| 43 | +### ISO 8601 timestamp (string) |
| 44 | + |
| 45 | +You can pass a string value representing a date to the `Date` constructor. |
| 46 | +The **only** format that is consistent across implementations is the [simplified version][mdn-date-string-format] of the internationally recognized and standardized so-called [ISO 8601 timestamp strings][defn-iso8601]. |
| 47 | + |
| 48 | +A moment in time at [UTC][defn-gmt] looks like this: |
| 49 | + |
| 50 | +```text |
| 51 | +YYYY-MM-DDTHH:MM:SSZ |
| 52 | +YYYYMMDDTHHMMSSZ |
| 53 | +``` |
| 54 | + |
| 55 | +Where the following substitutions take place: |
| 56 | + |
| 57 | +| Key | Description | |
| 58 | +| ---- | ------------------------------------------- | |
| 59 | +| YYYY | The calendar year, represented in 4 digits | |
| 60 | +| MM | The calendar month, represented in 2 digits | |
| 61 | +| DD | The calendar day, represented in 2 digits | |
| 62 | +| HH | The hours in a 24-hour clock, 2 digits | |
| 63 | +| MM | The minutes, 2 digits | |
| 64 | +| SS | The seconds, 2 digits | |
| 65 | + |
| 66 | +The letter `T` separates the date from the time. |
| 67 | +The letter `Z` indicates UTC (no timezone, no Day Light Savings). |
| 68 | + |
| 69 | +<!-- prettier-ignore --> |
| 70 | +~~~exercism/caution |
| 71 | +Other formats that are accepted by `Date.parse` may or may not work. |
| 72 | +When working with Dates in JavaScript, _always_ use an ISO 8601 timestamp when converting from a `string` to a `Date`. |
| 73 | +
|
| 74 | +Date-only forms are allowed, but not all ISO 8601 formats are supported. |
| 75 | +Consult the [simplified version explanation page on MDN][mdn-date-string-format]. |
| 76 | +~~~ |
| 77 | + |
| 78 | +If the timestamp does not end in `Z`, and it does not end with `+HH:MM` or `-HH:MM`, indicating a timezone offset, because of historical reasons, the following applies: |
| 79 | + |
| 80 | +> When the time zone offset is absent, date-only forms are interpreted as a UTC time and date-time forms are interpreted as a local time. |
| 81 | +> The interpretation as a UTC time is due to a historical spec error that was not consistent with ISO 8601 but could not be changed due to web compatibility. |
| 82 | +> See [Broken Parser – A Web Reality Issue][ref-broken-parser]. |
| 83 | +
|
| 84 | +### Date object |
| 85 | + |
| 86 | +An existing date object can also be used as a constructor argument. |
| 87 | +This makes a copy of the existing `Date` object with the same date and time. |
| 88 | + |
| 89 | +```javascript |
| 90 | +const t1 = new Date(); |
| 91 | +const t2 = new Date(t1); |
| 92 | +// Values of t1 and t2 will be the same. |
| 93 | +``` |
| 94 | + |
| 95 | +### Supplying individual date and time component values |
| 96 | + |
| 97 | +A date representing a date can be created by passing three numbers. |
| 98 | +A date representing a date and time can be created by passing in 6 numbers. |
| 99 | + |
| 100 | +```javascript |
| 101 | +const date1 = new Date(95, 11, 17); |
| 102 | +// Creates Date for Dec 17 1995 00:00 if your local timezone is equivalent to UTC. |
| 103 | + |
| 104 | +const date2 = new Date(2013, 12, 5, 13, 24, 0); |
| 105 | +// Creates Date for Jan 5 2014 13:24 if your local timezone is equivalent to UTC. |
| 106 | +``` |
| 107 | + |
| 108 | +The second value is the `month`, which starts at `0` for January, up to `11` for December. |
| 109 | + |
| 110 | +## `Date.parse()` |
| 111 | + |
| 112 | +You may find mentions of or references to a date parsing function `Date.parse`. |
| 113 | +Because there are only a few invariants (truths) for this function and because the rest of the implementation is not specified (and thus not standard), one should not use it. |
| 114 | + |
| 115 | +## Accessing `Date` components |
| 116 | + |
| 117 | +There are various methods on date objects that return the components of the date: |
| 118 | + |
| 119 | +```javascript |
| 120 | +getFullYear(); // Get the year (4 digits) |
| 121 | +getMonth(); // Get the month, from 0 to 11. |
| 122 | +getDate(); // Get the day of month, from 1 to 31. |
| 123 | +getHours(); // Get the hour in a 24 clock, from 0 to 23 |
| 124 | +getMinutes(); // Get the minutes, from 0 to 59 |
| 125 | +getSeconds(); // Get the seconds, from 0 to 59 |
| 126 | +getMilliseconds(); // Get the milliseconds, from 0 and 999 |
| 127 | +getDay(); // Get the day of week, from 0 (Sunday) to 6 (Saturday). |
| 128 | +``` |
| 129 | + |
| 130 | +Each of these has an applicable `set` variant (e.g. `setFullYear`) to update the value. |
| 131 | +Any overflowing value rolls over to the next component: |
| 132 | + |
| 133 | +```javascript |
| 134 | +const date = new Date('2025-02-28T12:42:00Z'); |
| 135 | +// => Fri Feb 28 2025 13:42:00 GMT+0100 (Central European Standard Time) |
| 136 | + |
| 137 | +date.setDate(29); |
| 138 | +// there was no February 29th in 2025. |
| 139 | + |
| 140 | +date.getDate(); |
| 141 | +// => 1 |
| 142 | + |
| 143 | +date.toString(); |
| 144 | +// => Sat Mar 01 2025 13:42:00 GMT+0100 (Central European Standard Time) |
| 145 | +``` |
| 146 | + |
| 147 | +There are UTC variants for all the methods that disregard the local timezone. |
| 148 | + |
| 149 | +## Converting from date |
| 150 | + |
| 151 | +Date objects have a method `getTime()` that returns the UNIX timestamp in milliseconds, ie. amount of milliseconds the midnight at the beginning of January 1, 1970, UTC. |
| 152 | +Additionally, a method `toISOString()` is available to convert from a date object to a ISO 8601 timestamp string. |
| 153 | + |
| 154 | +## Comparing Dates |
| 155 | + |
| 156 | +Greater than (`>`) and greater than or equals (`>=`) as well as less than (`<`) and less than or equals (`<=`) can be used directly between two dates or a date and a number. |
| 157 | +This works because JavaScript will try to coerce the date to a primitive. |
| 158 | + |
| 159 | +<!-- prettier-ignore --> |
| 160 | +~~~@exercism/advanced |
| 161 | +When doing a comparison between two dates or date and a number, JavaScript calls [`[Symbol.toPrimitive]("number")`][mdn-to-primitive] which internally calls [`date.valueOf()`][mdn-date-value-of]. |
| 162 | +The latter is the same as calling [`date.getTime()`][mdn-date-get-time]. |
| 163 | +
|
| 164 | +If you do not want to rely on this behaviour, convert to a number using `getTime()` first. |
| 165 | +~~~ |
| 166 | + |
| 167 | +Dates cannot be compared using equality (`==`, and `===`), but the result of `.getTime()` can. |
| 168 | + |
| 169 | +[defn-utc]: https://simple.wikipedia.org/wiki/Coordinated_Universal_Time |
| 170 | +[defn-gmt]: https://simple.wikipedia.org/wiki/Greenwich_Mean_Time |
| 171 | +[defn-unix-epoch]: https://en.wikipedia.org/wiki/Epoch_%28computing%29 |
| 172 | +[defn-iso8601]: https://en.wikipedia.org/wiki/ISO_8601 |
| 173 | +[mdn-temporal]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Temporal |
| 174 | +[mdn-diff-assumed-timezone]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse#differences_in_assumed_time_zone |
| 175 | +[mdn-date-string-format]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date#date_time_string_format |
| 176 | +[mdn-to-primitive]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Symbol.toPrimitive |
| 177 | +[mdn-date-value-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/valueOf |
| 178 | +[mdn-date-get-time]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/getTime |
| 179 | +[ref-broken-parser]: https://maggiepint.com/2017/04/11/fixing-javascript-date-web-compatibility-and-reality/ |
0 commit comments