date-vir 4.0.2 → 4.1.0

package/dist/cjs/formatting/relative-string.js

@@ -4,6 +4,17 @@ exports.toRelativeString = void 0;
 const common_1 = require("@augment-vir/common");
 const diff_dates_1 = require("../date-operations/diff-dates");
 const duration_1 = require("../duration");
+const maxDurations = {
+    [duration_1.DurationUnit.Milliseconds]: 1000,
+    [duration_1.DurationUnit.Seconds]: 60,
+    [duration_1.DurationUnit.Minutes]: 60,
+    [duration_1.DurationUnit.Hours]: 24,
+    [duration_1.DurationUnit.Days]: 30,
+    [duration_1.DurationUnit.Weeks]: 4,
+    [duration_1.DurationUnit.Months]: 12,
+    [duration_1.DurationUnit.Quarters]: 4,
+    [duration_1.DurationUnit.Years]: Infinity,
+};
 function toRelativeString({ fullDate, relativeTo, options = {}, }) {
     const roundingDigits = options.decimalDigitCount || 0;
     const allUnitDiffs = (0, diff_dates_1.diffDatesAllUnits)({
@@ -11,8 +22,12 @@ function toRelativeString({ fullDate, relativeTo, options = {}, }) {
         end: relativeTo,
     });
     const unitsWithinBounds = (0, common_1.mapObjectValues)(allUnitDiffs, (durationUnit, duration) => {
-        const isAboveZero = Math.floor(Math.abs((0, common_1.round)({ digits: 1, number: duration }))) > 0;
-        return isAboveZero;
+        const roundedDuration = Math.floor(Math.abs((0, common_1.round)({ digits: 1, number: duration })));
+        const isAboveZero = roundedDuration > 0;
+        const isBelowMax = options.limitUnitMax
+            ? roundedDuration < maxDurations[durationUnit]
+            : true;
+        return isAboveZero && isBelowMax;
     });
     const unitToUse = duration_1.orderedDurationUnits.reduce((chosenUnit, currentUnit) => {
         const isUnitAllowed = !options.blockedRelativeUnits?.includes(currentUnit);

package/dist/esm/formatting/relative-string.d.ts

@@ -17,6 +17,12 @@ export type RelativeStringOptions = {
     decimalDigitCount: number;
     /** Set this to true to block the 'just now' relative string. By default, that string is allowed. */
     blockJustNow: true;
+    /**
+     * Set to true to limit durations to their max value. Each unit's max value is its value when it
+     * turns into the subsequent unit. For example, seconds maxes out at 60, at which point it
+     * becomes a minute.
+     */
+    limitUnitMax: true;
 };
 export declare function toRelativeString({ fullDate, relativeTo, options, }: {
     fullDate: Readonly<FullDate>;

package/dist/esm/formatting/relative-string.js

@@ -1,6 +1,17 @@
 import { areJsonEqual, mapObjectValues, round } from '@augment-vir/common';
 import { diffDatesAllUnits } from '../date-operations/diff-dates';
 import { DurationUnit, orderedDurationUnits, singularDurationUnitNames } from '../duration';
+const maxDurations = {
+    [DurationUnit.Milliseconds]: 1000,
+    [DurationUnit.Seconds]: 60,
+    [DurationUnit.Minutes]: 60,
+    [DurationUnit.Hours]: 24,
+    [DurationUnit.Days]: 30,
+    [DurationUnit.Weeks]: 4,
+    [DurationUnit.Months]: 12,
+    [DurationUnit.Quarters]: 4,
+    [DurationUnit.Years]: Infinity,
+};
 export function toRelativeString({ fullDate, relativeTo, options = {}, }) {
     const roundingDigits = options.decimalDigitCount || 0;
     const allUnitDiffs = diffDatesAllUnits({
@@ -8,8 +19,12 @@ export function toRelativeString({ fullDate, relativeTo, options = {}, }) {
         end: relativeTo,
     });
     const unitsWithinBounds = mapObjectValues(allUnitDiffs, (durationUnit, duration) => {
-        const isAboveZero = Math.floor(Math.abs(round({ digits: 1, number: duration }))) > 0;
-        return isAboveZero;
+        const roundedDuration = Math.floor(Math.abs(round({ digits: 1, number: duration })));
+        const isAboveZero = roundedDuration > 0;
+        const isBelowMax = options.limitUnitMax
+            ? roundedDuration < maxDurations[durationUnit]
+            : true;
+        return isAboveZero && isBelowMax;
     });
     const unitToUse = orderedDurationUnits.reduce((chosenUnit, currentUnit) => {
         const isUnitAllowed = !options.blockedRelativeUnits?.includes(currentUnit);

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "date-vir",
-    "version": "4.0.2",
+    "version": "4.1.0",
     "description": "Easy and explicit dates and times",
     "keywords": [
         "date",