diff options
Diffstat (limited to 'date-fns/src/formatRFC3339')
-rw-r--r-- | date-fns/src/formatRFC3339/index.d.ts | 4 | ||||
-rw-r--r-- | date-fns/src/formatRFC3339/index.js | 92 | ||||
-rw-r--r-- | date-fns/src/formatRFC3339/index.js.flow | 57 | ||||
-rw-r--r-- | date-fns/src/formatRFC3339/test.js | 81 |
4 files changed, 234 insertions, 0 deletions
diff --git a/date-fns/src/formatRFC3339/index.d.ts b/date-fns/src/formatRFC3339/index.d.ts new file mode 100644 index 0000000..2454cd2 --- /dev/null +++ b/date-fns/src/formatRFC3339/index.d.ts @@ -0,0 +1,4 @@ +// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it. + +import { formatRFC3339 } from 'date-fns' +export default formatRFC3339 diff --git a/date-fns/src/formatRFC3339/index.js b/date-fns/src/formatRFC3339/index.js new file mode 100644 index 0000000..7513ba4 --- /dev/null +++ b/date-fns/src/formatRFC3339/index.js @@ -0,0 +1,92 @@ +import toDate from '../toDate/index' +import isValid from '../isValid/index' +import addLeadingZeros from '../_lib/addLeadingZeros/index' +import toInteger from '../_lib/toInteger/index' + +/** + * @name formatRFC3339 + * @category Common Helpers + * @summary Format the date according to the RFC 3339 standard (https://tools.ietf.org/html/rfc3339#section-5.6). + * + * @description + * Return the formatted date string in RFC 3339 format. Options may be passed to control the parts and notations of the date. + * + * @param {Date|Number} date - the original date + * @param {Object} [options] - an object with options. + * @param {0|1|2|3} [options.fractionDigits=0] - number of digits after the decimal point after seconds + * @returns {String} the formatted date string + * @throws {TypeError} 1 argument required + * @throws {RangeError} `date` must not be Invalid Date + * @throws {RangeError} `options.fractionDigits` must be between 0 and 3 + * + * @example + * // Represent 18 September 2019 in RFC 3339 format: + * const result = formatRFC3339(new Date(2019, 8, 18, 19, 0, 52)) + * //=> '2019-09-18T19:00:52Z' + * + * @example + * // Represent 18 September 2019 in RFC 3339 format, 2 digits of second fraction: + * const result = formatRFC3339(new Date(2019, 8, 18, 19, 0, 52, 234), { fractionDigits: 2 }) + * //=> '2019-09-18T19:00:52.23Z' + * + * @example + * // Represent 18 September 2019 in RFC 3339 format, 3 digits of second fraction + * const result = formatRFC3339(new Date(2019, 8, 18, 19, 0, 52, 234), { fractionDigits: 3 }) + * //=> '2019-09-18T19:00:52.234Z' + */ +export default function formatRFC3339(dirtyDate, dirtyOptions) { + if (arguments.length < 1) { + throw new TypeError( + `1 arguments required, but only ${arguments.length} present` + ) + } + + const originalDate = toDate(dirtyDate) + + if (!isValid(originalDate)) { + throw new RangeError('Invalid time value') + } + + const options = dirtyOptions || {} + const fractionDigits = + options.fractionDigits == null ? 0 : toInteger(options.fractionDigits) + + // Test if fractionDigits is between 0 and 3 _and_ is not NaN + if (!(fractionDigits >= 0 && fractionDigits <= 3)) { + throw new RangeError('fractionDigits must be between 0 and 3 inclusively') + } + + const day = addLeadingZeros(originalDate.getDate(), 2) + const month = addLeadingZeros(originalDate.getMonth() + 1, 2) + const year = originalDate.getFullYear() + + const hour = addLeadingZeros(originalDate.getHours(), 2) + const minute = addLeadingZeros(originalDate.getMinutes(), 2) + const second = addLeadingZeros(originalDate.getSeconds(), 2) + + let fractionalSecond = '' + if (fractionDigits > 0) { + const milliseconds = originalDate.getMilliseconds() + const fractionalSeconds = Math.floor( + milliseconds * Math.pow(10, fractionDigits - 3) + ) + fractionalSecond = '.' + addLeadingZeros(fractionalSeconds, fractionDigits) + } + + let offset = '' + const tzOffset = originalDate.getTimezoneOffset() + + if (tzOffset !== 0) { + const absoluteOffset = Math.abs(tzOffset) + const hourOffset = addLeadingZeros(toInteger(absoluteOffset / 60), 2) + const minuteOffset = addLeadingZeros(absoluteOffset % 60, 2) + // If less than 0, the sign is +, because it is ahead of time. + const sign = tzOffset < 0 ? '+' : '-' + + offset = `${sign}${hourOffset}:${minuteOffset}` + } else { + offset = 'Z' + } + + return `${year}-${month}-${day}T${hour}:${minute}:${second}${fractionalSecond}${offset}` +} diff --git a/date-fns/src/formatRFC3339/index.js.flow b/date-fns/src/formatRFC3339/index.js.flow new file mode 100644 index 0000000..9bb2748 --- /dev/null +++ b/date-fns/src/formatRFC3339/index.js.flow @@ -0,0 +1,57 @@ +// @flow +// This file is generated automatically by `scripts/build/typings.js`. Please, don't change it. + +export type Interval = { + start: Date | number, + end: Date | number, +} + +export type Locale = { + code?: string, + formatDistance?: (...args: Array<any>) => any, + formatRelative?: (...args: Array<any>) => any, + localize?: { + ordinalNumber: (...args: Array<any>) => any, + era: (...args: Array<any>) => any, + quarter: (...args: Array<any>) => any, + month: (...args: Array<any>) => any, + day: (...args: Array<any>) => any, + dayPeriod: (...args: Array<any>) => any, + }, + formatLong?: { + date: (...args: Array<any>) => any, + time: (...args: Array<any>) => any, + dateTime: (...args: Array<any>) => any, + }, + match?: { + ordinalNumber: (...args: Array<any>) => any, + era: (...args: Array<any>) => any, + quarter: (...args: Array<any>) => any, + month: (...args: Array<any>) => any, + day: (...args: Array<any>) => any, + dayPeriod: (...args: Array<any>) => any, + }, + options?: { + weekStartsOn?: 0 | 1 | 2 | 3 | 4 | 5 | 6, + firstWeekContainsDate?: 1 | 2 | 3 | 4 | 5 | 6 | 7, + }, +} + +export type Duration = { + years?: number, + months?: number, + weeks?: number, + days?: number, + hours?: number, + minutes?: number, + seconds?: number, +} + +export type Day = 0 | 1 | 2 | 3 | 4 | 5 | 6 + +declare module.exports: ( + date: Date | number, + options?: { + fractionDigits?: 0 | 1 | 2 | 3, + } +) => string diff --git a/date-fns/src/formatRFC3339/test.js b/date-fns/src/formatRFC3339/test.js new file mode 100644 index 0000000..5d9e468 --- /dev/null +++ b/date-fns/src/formatRFC3339/test.js @@ -0,0 +1,81 @@ +// @flow +/* eslint-env mocha */ + +import assert from 'power-assert' +import formatRFC3339 from '.' +import toInteger from '../_lib/toInteger/index' +import addLeadingZeros from '../_lib/addLeadingZeros/index' + +// This makes sure we create the consistent offsets across timezones, no matter where these tests are ran. +function generateOffset(date) { + let offset = '' + const tzOffset = date.getTimezoneOffset() + + if (tzOffset !== 0) { + const absoluteOffset = Math.abs(tzOffset) + const hourOffset = addLeadingZeros(toInteger(absoluteOffset / 60), 2) + const minuteOffset = addLeadingZeros(absoluteOffset % 60, 2) + // If less than 0, the sign is +, because it is ahead of time. + const sign = tzOffset < 0 ? '+' : '-' + + offset = `${sign}${hourOffset}:${minuteOffset}` + } else { + offset = 'Z' + } + + return offset +} + +describe('formatRFC3339', () => { + it('formats RFC-3339 date string', () => { + var date = new Date(2019, 2 /* Mar */, 3, 19, 0, 52, 123) + assert(formatRFC3339(date) === `2019-03-03T19:00:52${generateOffset(date)}`) + }) + + it('accepts a timestamp', function() { + var date = new Date(2019, 9 /* Oct */, 4, 12, 30, 13, 456) + var time = date.getTime() + assert(formatRFC3339(time) === `2019-10-04T12:30:13${generateOffset(date)}`) + }) + + it('allows to specify digits of second fractions', function() { + var date = new Date(2019, 11 /* Dec */, 11, 1, 0, 0, 789) + assert( + formatRFC3339(date, { fractionDigits: 3 }) === + `2019-12-11T01:00:00.789${generateOffset(date)}` + ) + }) + + it('works when ms < 100', function() { + var date = new Date(2019, 11 /* Dec */, 11, 1, 0, 0, 12) + assert( + formatRFC3339(date, { fractionDigits: 2 }) === + `2019-12-11T01:00:00.01${generateOffset(date)}` + ) + }) + + it('implicitly converts options', function() { + var date = new Date(2019, 2 /* Mar */, 3, 19, 0, 52, 123) + // $ExpectedMistake + var result = formatRFC3339(date, { + fractionDigits: '2' + }) + assert.equal(result, `2019-03-03T19:00:52.12${generateOffset(date)}`) + }) + + it('throws `RangeError` if `options.fractionDigits` is not convertable to 0, 1, 2, 3 or undefined', function() { + // $ExpectedMistake + var block = formatRFC3339.bind(null, new Date(2019, 2 /* Mar */, 3), { + fractionDigits: NaN + }) + assert.throws(block, RangeError) + }) + + it('throws RangeError if the time value is invalid', () => { + assert.throws(formatRFC3339.bind(null, new Date(NaN)), RangeError) + }) + + it('throws TypeError exception if passed less than 1 argument', function() { + assert.throws(formatRFC3339.bind(null), TypeError) + }) +}) |