Very Popular
Latest
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284import getTimezoneOffsetInMilliseconds from '../_lib/getTimezoneOffsetInMilliseconds/index.js'import compareAsc from '../compareAsc/index.ts'import toDate from '../toDate/index.ts'import cloneObject from '../_lib/cloneObject/index.js'import defaultLocale from '../locale/en-US/index.js'import requiredArgs from '../_lib/requiredArgs/index.ts'import { LocaleOptions, Unit } from '../types.ts';
const MILLISECONDS_IN_MINUTE = 1000 * 60const MINUTES_IN_DAY = 60 * 24const MINUTES_IN_MONTH = MINUTES_IN_DAY * 30const MINUTES_IN_YEAR = MINUTES_IN_DAY * 365
/** * @name formatDistanceStrict * @category Common Helpers * @summary Return the distance between the given dates in words. * * @description * Return the distance between the given dates in words, using strict units. * This is like `formatDistance`, but does not use helpers like 'almost', 'over', * 'less than' and the like. * * | Distance between dates | Result | * |------------------------|---------------------| * | 0 ... 59 secs | [0..59] seconds | * | 1 ... 59 mins | [1..59] minutes | * | 1 ... 23 hrs | [1..23] hours | * | 1 ... 29 days | [1..29] days | * | 1 ... 11 months | [1..11] months | * | 1 ... N years | [1..N] years | * * ### v2.0.0 breaking changes: * * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes). * * - The function was renamed from `distanceInWordsStrict` to `formatDistanceStrict` * to make its name consistent with `format` and `formatRelative`. * * - The order of arguments is swapped to make the function * consistent with `differenceIn...` functions. * * ```javascript * // Before v2.0.0 * * distanceInWordsStrict( * new Date(2015, 0, 2), * new Date(2014, 6, 2) * ) //=> '6 months' * * // v2.0.0 onward * * formatDistanceStrict( * new Date(2014, 6, 2), * new Date(2015, 0, 2) * ) //=> '6 months' * ``` * * - `partialMethod` option is renamed to `roundingMethod`. * * ```javascript * // Before v2.0.0 * * distanceInWordsStrict( * new Date(1986, 3, 4, 10, 32, 0), * new Date(1986, 3, 4, 10, 33, 1), * { partialMethod: 'ceil' } * ) //=> '2 minutes' * * // v2.0.0 onward * * formatDistanceStrict( * new Date(1986, 3, 4, 10, 33, 1), * new Date(1986, 3, 4, 10, 32, 0), * { roundingMethod: 'ceil' } * ) //=> '2 minutes' * ``` * * - If `roundingMethod` is not specified, it now defaults to `round` instead of `floor`. * * - `unit` option now accepts one of the strings: * 'second', 'minute', 'hour', 'day', 'month' or 'year' instead of 's', 'm', 'h', 'd', 'M' or 'Y' * * ```javascript * // Before v2.0.0 * * distanceInWordsStrict( * new Date(1986, 3, 4, 10, 32, 0), * new Date(1986, 3, 4, 10, 33, 1), * { unit: 'm' } * ) * * // v2.0.0 onward * * formatDistanceStrict( * new Date(1986, 3, 4, 10, 33, 1), * new Date(1986, 3, 4, 10, 32, 0), * { unit: 'minute' } * ) * ``` * * @param {Date|Number} date - the date * @param {Date|Number} baseDate - the date to compare with * @param {Object} [options] - an object with options. * @param {Boolean} [options.addSuffix=false] - result indicates if the second date is earlier or later than the first * @param {'second'|'minute'|'hour'|'day'|'month'|'year'} [options.unit] - if specified, will force a unit * @param {'floor'|'ceil'|'round'} [options.roundingMethod='round'] - which way to round partial units * @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale} * @returns {String} the distance in words * @throws {TypeError} 2 arguments required * @throws {RangeError} `date` must not be Invalid Date * @throws {RangeError} `baseDate` must not be Invalid Date * @throws {RangeError} `options.roundingMethod` must be 'floor', 'ceil' or 'round' * @throws {RangeError} `options.unit` must be 'second', 'minute', 'hour', 'day', 'month' or 'year' * @throws {RangeError} `options.locale` must contain `formatDistance` property * * @example * // What is the distance between 2 July 2014 and 1 January 2015? * const result = formatDistanceStrict(new Date(2014, 6, 2), new Date(2015, 0, 2)) * //=> '6 months' * * @example * // What is the distance between 1 January 2015 00:00:15 * // and 1 January 2015 00:00:00? * const result = formatDistanceStrict( * new Date(2015, 0, 1, 0, 0, 15), * new Date(2015, 0, 1, 0, 0, 0) * ) * //=> '15 seconds' * * @example * // What is the distance from 1 January 2016 * // to 1 January 2015, with a suffix? * const result = formatDistanceStrict(new Date(2015, 0, 1), new Date(2016, 0, 1), { * addSuffix: true * }) * //=> '1 year ago' * * @example * // What is the distance from 1 January 2016 * // to 1 January 2015, in minutes? * const result = formatDistanceStrict(new Date(2016, 0, 1), new Date(2015, 0, 1), { * unit: 'minute' * }) * //=> '525600 minutes' * * @example * // What is the distance from 1 January 2015 * // to 28 January 2015, in months, rounded up? * const result = formatDistanceStrict(new Date(2015, 0, 28), new Date(2015, 0, 1), { * unit: 'month', * roundingMethod: 'ceil' * }) * //=> '1 month' * * @example * // What is the distance between 1 August 2016 and 1 January 2015 in Esperanto? * import { eoLocale } from 'date-fns/locale/eo' * const result = formatDistanceStrict(new Date(2016, 7, 1), new Date(2015, 0, 1), { * locale: eoLocale * }) * //=> '1 jaro' */
export default function formatDistanceStrict( dirtyDate: Date | number, dirtyBaseDate: Date | number, options: LocaleOptions & { addSuffix?: boolean, unit?: Unit, roundingMethod?: 'floor' | 'ceil' | 'round', } = {}): string { requiredArgs(2, arguments)
const locale = options.locale || defaultLocale
if (!locale.formatDistance) { throw new RangeError('locale must contain localize.formatDistance property') }
const comparison = compareAsc(dirtyDate, dirtyBaseDate)
if (isNaN(comparison)) { throw new RangeError('Invalid time value') }
const localizeOptions = cloneObject(options) localizeOptions.addSuffix = Boolean(options.addSuffix) localizeOptions.comparison = comparison
let dateLeft let dateRight if (comparison > 0) { dateLeft = toDate(dirtyBaseDate) dateRight = toDate(dirtyDate) } else { dateLeft = toDate(dirtyDate) dateRight = toDate(dirtyBaseDate) }
const roundingMethod = options.roundingMethod == null ? 'round' : String(options.roundingMethod) let roundingMethodFn
if (roundingMethod === 'floor') { roundingMethodFn = Math.floor } else if (roundingMethod === 'ceil') { roundingMethodFn = Math.ceil } else if (roundingMethod === 'round') { roundingMethodFn = Math.round } else { throw new RangeError("roundingMethod must be 'floor', 'ceil' or 'round'") }
const milliseconds = dateRight.getTime() - dateLeft.getTime() const minutes = milliseconds / MILLISECONDS_IN_MINUTE
const timezoneOffset = getTimezoneOffsetInMilliseconds(dateRight) - getTimezoneOffsetInMilliseconds(dateLeft)
// Use DST-normalized difference in minutes for years, months and days; // use regular difference in minutes for hours, minutes and seconds. const dstNormalizedMinutes = (milliseconds - timezoneOffset) / MILLISECONDS_IN_MINUTE
let unit if (options.unit == null) { if (minutes < 1) { unit = 'second' } else if (minutes < 60) { unit = 'minute' } else if (minutes < MINUTES_IN_DAY) { unit = 'hour' } else if (dstNormalizedMinutes < MINUTES_IN_MONTH) { unit = 'day' } else if (dstNormalizedMinutes < MINUTES_IN_YEAR) { unit = 'month' } else { unit = 'year' } } else { unit = String(options.unit) }
// 0 up to 60 seconds if (unit === 'second') { const seconds = roundingMethodFn(milliseconds / 1000) return locale.formatDistance('xSeconds', seconds, localizeOptions)
// 1 up to 60 mins } else if (unit === 'minute') { const roundedMinutes = roundingMethodFn(minutes) return locale.formatDistance('xMinutes', roundedMinutes, localizeOptions)
// 1 up to 24 hours } else if (unit === 'hour') { const hours = roundingMethodFn(minutes / 60) return locale.formatDistance('xHours', hours, localizeOptions)
// 1 up to 30 days } else if (unit === 'day') { const days = roundingMethodFn(dstNormalizedMinutes / MINUTES_IN_DAY) return locale.formatDistance('xDays', days, localizeOptions)
// 1 up to 12 months } else if (unit === 'month') { const months = roundingMethodFn(dstNormalizedMinutes / MINUTES_IN_MONTH) return months === 12 && options.unit !== 'month' ? locale.formatDistance('xYears', 1, localizeOptions) : locale.formatDistance('xMonths', months, localizeOptions)
// 1 year up to max Date } else if (unit === 'year') { const years = roundingMethodFn(dstNormalizedMinutes / MINUTES_IN_YEAR) return locale.formatDistance('xYears', years, localizeOptions) }
throw new RangeError( "unit must be 'second', 'minute', 'hour', 'day', 'month' or 'year'" )}