UNPKG

1.74 kBTypeScriptView Raw
1/**
2 * @name parseJSON
3 * @category Common Helpers
4 * @summary Parse a JSON date string
5 *
6 * @description
7 * Converts a complete ISO date string in UTC time, the typical format for transmitting
8 * a date in JSON, to a JavaScript `Date` instance.
9 *
10 * This is a minimal implementation for converting dates retrieved from a JSON API to
11 * a `Date` instance which can be used with other functions in the `date-fns` library.
12 * The following formats are supported:
13 *
14 * - `2000-03-15T05:20:10.123Z`: The output of `.toISOString()` and `JSON.stringify(new Date())`
15 * - `2000-03-15T05:20:10Z`: Without milliseconds
16 * - `2000-03-15T05:20:10+00:00`: With a zero offset, the default JSON encoded format in some other languages
17 * - `2000-03-15T05:20:10+05:45`: With a positive or negative offset, the default JSON encoded format in some other languages
18 * - `2000-03-15T05:20:10+0000`: With a zero offset without a colon
19 * - `2000-03-15T05:20:10`: Without a trailing 'Z' symbol
20 * - `2000-03-15T05:20:10.1234567`: Up to 7 digits in milliseconds field. Only first 3 are taken into account since JS does not allow fractional milliseconds
21 * - `2000-03-15 05:20:10`: With a space instead of a 'T' separator for APIs returning a SQL date without reformatting
22 *
23 * For convenience and ease of use these other input types are also supported
24 * via [toDate](https://date-fns.org/docs/toDate):
25 *
26 * - A `Date` instance will be cloned
27 * - A `number` will be treated as a timestamp
28 *
29 * Any other input type or invalid date strings will return an `Invalid Date`.
30 *
31 * @param dateStr - A fully formed ISO8601 date string to convert
32 *
33 * @returns The parsed date in the local time zone
34 */
35export declare function parseJSON(dateStr: string): Date;