123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106 |
- "use strict";
- exports.formatISO = formatISO;
- var _index = require("./_lib/addLeadingZeros.cjs");
- var _index2 = require("./toDate.cjs");
- /**
- * The {@link formatISO} function options.
- */
- /**
- * @name formatISO
- * @category Common Helpers
- * @summary Format the date according to the ISO 8601 standard (https://support.sas.com/documentation/cdl/en/lrdict/64316/HTML/default/viewer.htm#a003169814.htm).
- *
- * @description
- * Return the formatted date string in ISO 8601 format. Options may be passed to control the parts and notations of the date.
- *
- * @param date - The original date
- * @param options - An object with options.
- *
- * @returns The formatted date string (in local time zone)
- *
- * @throws `date` must not be Invalid Date
- *
- * @example
- * // Represent 18 September 2019 in ISO 8601 format (local time zone is UTC):
- * const result = formatISO(new Date(2019, 8, 18, 19, 0, 52))
- * //=> '2019-09-18T19:00:52Z'
- *
- * @example
- * // Represent 18 September 2019 in ISO 8601, short format (local time zone is UTC):
- * const result = formatISO(new Date(2019, 8, 18, 19, 0, 52), { format: 'basic' })
- * //=> '20190918T190052'
- *
- * @example
- * // Represent 18 September 2019 in ISO 8601 format, date only:
- * const result = formatISO(new Date(2019, 8, 18, 19, 0, 52), { representation: 'date' })
- * //=> '2019-09-18'
- *
- * @example
- * // Represent 18 September 2019 in ISO 8601 format, time only (local time zone is UTC):
- * const result = formatISO(new Date(2019, 8, 18, 19, 0, 52), { representation: 'time' })
- * //=> '19:00:52Z'
- */
- function formatISO(date, options) {
- const date_ = (0, _index2.toDate)(date, options?.in);
- if (isNaN(+date_)) {
- throw new RangeError("Invalid time value");
- }
- const format = options?.format ?? "extended";
- const representation = options?.representation ?? "complete";
- let result = "";
- let tzOffset = "";
- const dateDelimiter = format === "extended" ? "-" : "";
- const timeDelimiter = format === "extended" ? ":" : "";
- // Representation is either 'date' or 'complete'
- if (representation !== "time") {
- const day = (0, _index.addLeadingZeros)(date_.getDate(), 2);
- const month = (0, _index.addLeadingZeros)(date_.getMonth() + 1, 2);
- const year = (0, _index.addLeadingZeros)(date_.getFullYear(), 4);
- // yyyyMMdd or yyyy-MM-dd.
- result = `${year}${dateDelimiter}${month}${dateDelimiter}${day}`;
- }
- // Representation is either 'time' or 'complete'
- if (representation !== "date") {
- // Add the timezone.
- const offset = date_.getTimezoneOffset();
- if (offset !== 0) {
- const absoluteOffset = Math.abs(offset);
- const hourOffset = (0, _index.addLeadingZeros)(
- Math.trunc(absoluteOffset / 60),
- 2,
- );
- const minuteOffset = (0, _index.addLeadingZeros)(absoluteOffset % 60, 2);
- // If less than 0, the sign is +, because it is ahead of time.
- const sign = offset < 0 ? "+" : "-";
- tzOffset = `${sign}${hourOffset}:${minuteOffset}`;
- } else {
- tzOffset = "Z";
- }
- const hour = (0, _index.addLeadingZeros)(date_.getHours(), 2);
- const minute = (0, _index.addLeadingZeros)(date_.getMinutes(), 2);
- const second = (0, _index.addLeadingZeros)(date_.getSeconds(), 2);
- // If there's also date, separate it with time with 'T'
- const separator = result === "" ? "" : "T";
- // Creates a time string consisting of hour, minute, and second, separated by delimiters, if defined.
- const time = [hour, minute, second].join(timeDelimiter);
- // HHmmss or HH:mm:ss.
- result = `${result}${separator}${time}${tzOffset}`;
- }
- return result;
- }
|