npm - @prairielearn/formatter - Versions diffs - 1.4.2 → 1.4.4 - Mend

@prairielearn/formatter 1.4.2 → 1.4.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,17 @@
 # @prairielearn/formatter
+## 1.4.4
+### Patch Changes
+- b55261c: Upgrade to TypeScript 5.9
+## 1.4.3
+### Patch Changes
+- 23adb05: Upgrade all JavaScript dependencies
 ## 1.4.2
 ### Patch Changes

package/dist/date.d.ts CHANGED Viewed

@@ -4,8 +4,10 @@ type TimePrecision = 'hour' | 'minute' | 'second';
  *
  * @param date The date to format.
  * @param timeZone The time zone to use for formatting.
- * @param param2.includeTz Whether to include the time zone in the output (default true).
- * @param param2.longTz Whether to use the long time zone name (default false).
+ * @param options
+ * @param options.includeMs Whether to include milliseconds in the output (default false).
+ * @param options.includeTz Whether to include the time zone in the output (default true).
+ * @param options.longTz Whether to use the long time zone name (default false).
  * @returns Human-readable string representing the date.
  */
 export declare function formatDate(date: Date, timeZone: string, { includeTz, longTz, includeMs, }?: {
@@ -41,7 +43,8 @@ export declare function formatTz(timeZone: string): string;
  *
  * @param date The date to format.
  * @param timeZone The time zone to use for formatting.
- * @param param2.includeTz Whether to include the time zone in the output (default true).
+ * @param options
+ * @param options.includeTz Whether to include the time zone in the output (default true).
  * @returns Human-readable string representing the date.
  */
 export declare function formatDateHMS(date: Date, timeZone: string, { includeTz }?: {
@@ -74,13 +77,14 @@ export declare function formatDateWithinRange(date: Date, rangeStart: Date, rang
  *
  * @param date The date to format.
  * @param timezone The time zone to use for formatting.
- * @param param.baseDate The base date to use for comparison (default is the current date).
- * @param param.includeTz Whether to include the time zone in the output (default true).
- * @param param.timeFirst If true, the time is shown before the date (default false).
- * @param param.dateOnly If true, only the date is shown (default false).
- * @param param.timeOnly If true, only the time is shown (default false).
- * @param param.maxPrecision The maximum precision to show for time (default 'minute').
- * @param param.minPrecision The minimum precision to always show for time (default 'hour').
+ * @param options
+ * @param options.baseDate The base date to use for comparison (default is the current date).
+ * @param options.includeTz Whether to include the time zone in the output (default true).
+ * @param options.timeFirst If true, the time is shown before the date (default false).
+ * @param options.dateOnly If true, only the date is shown (default false).
+ * @param options.timeOnly If true, only the time is shown (default false).
+ * @param options.maxPrecision The maximum precision to show for time (default 'minute').
+ * @param options.minPrecision The minimum precision to always show for time (default 'hour').
  * @returns Human-readable string representing the date and time.
  */
 export declare function formatDateFriendly(date: Date, timezone: string, { baseDate, includeTz, timeFirst, dateOnly, timeOnly, maxPrecision, minPrecision, }?: {
@@ -107,6 +111,12 @@ export declare function formatDateFriendly(date: Date, timezone: string, { baseD
  * @param end The end date and time.
  * @param timezone The time zone to use for formatting.
  * @param options Additional options for formatting the displayed date, taken from `formatDateFriendlyString()`.
+ * @param options.baseDate The base date to use for comparison (default is the current date).
+ * @param options.includeTz Whether to include the time zone in the output (default true).
+ * @param options.timeFirst If true, the time is shown before the date (default false).
+ * @param options.dateOnly If true, only the date is shown (default false).
+ * @param options.maxPrecision The maximum precision to show for time (default 'minute').
+ * @param options.minPrecision The minimum precision to always show for time (default 'hour').
  * @returns Human-readable string representing the datetime range.
  */
 export declare function formatDateRangeFriendly(start: Date, end: Date, timezone: string, { baseDate, includeTz, timeFirst, dateOnly, maxPrecision, minPrecision, }?: Parameters<typeof formatDateFriendly>[2]): string;

package/dist/date.js CHANGED Viewed

@@ -5,8 +5,10 @@ import keyBy from 'lodash/keyBy.js';
  *
  * @param date The date to format.
  * @param timeZone The time zone to use for formatting.
- * @param param2.includeTz Whether to include the time zone in the output (default true).
- * @param param2.longTz Whether to use the long time zone name (default false).
+ * @param options
+ * @param options.includeMs Whether to include milliseconds in the output (default false).
+ * @param options.includeTz Whether to include the time zone in the output (default true).
+ * @param options.longTz Whether to use the long time zone name (default false).
  * @returns Human-readable string representing the date.
  */
 export function formatDate(date, timeZone, { includeTz = true, longTz = false, includeMs = false, } = {}) {
@@ -90,7 +92,8 @@ export function formatTz(timeZone) {
  *
  * @param date The date to format.
  * @param timeZone The time zone to use for formatting.
- * @param param2.includeTz Whether to include the time zone in the output (default true).
+ * @param options
+ * @param options.includeTz Whether to include the time zone in the output (default true).
  * @returns Human-readable string representing the date.
  */
 export function formatDateHMS(date, timeZone, { includeTz = true } = {}) {
@@ -245,7 +248,8 @@ function formatDateFriendlyParts(date, timezone, baseDate, maxPrecision = 'secon
     if (maxIndex > minIndex) {
         throw new Error('maxPrecision must be an equal or smaller unit than minPrecision.');
     }
-    /** Examples:
+    /**
+     * Examples:
      * min=h, max=h: 0:00:00AM -> 0AM, 0:00:01AM -> 0AM, 0:01:01AM -> 0AM
      * min=h, max=m: 0:00:00AM -> 0AM, 0:00:01AM -> 0AM, 0:01:01AM -> 0:01AM
      * min=h, max=s: 0:00:00AM -> 0AM, 0:00:01AM -> 0:00:01AM, 0:01:01AM -> 0:01:01AM
@@ -292,13 +296,14 @@ function formatDateFriendlyParts(date, timezone, baseDate, maxPrecision = 'secon
  *
  * @param date The date to format.
  * @param timezone The time zone to use for formatting.
- * @param param.baseDate The base date to use for comparison (default is the current date).
- * @param param.includeTz Whether to include the time zone in the output (default true).
- * @param param.timeFirst If true, the time is shown before the date (default false).
- * @param param.dateOnly If true, only the date is shown (default false).
- * @param param.timeOnly If true, only the time is shown (default false).
- * @param param.maxPrecision The maximum precision to show for time (default 'minute').
- * @param param.minPrecision The minimum precision to always show for time (default 'hour').
+ * @param options
+ * @param options.baseDate The base date to use for comparison (default is the current date).
+ * @param options.includeTz Whether to include the time zone in the output (default true).
+ * @param options.timeFirst If true, the time is shown before the date (default false).
+ * @param options.dateOnly If true, only the date is shown (default false).
+ * @param options.timeOnly If true, only the time is shown (default false).
+ * @param options.maxPrecision The maximum precision to show for time (default 'minute').
+ * @param options.minPrecision The minimum precision to always show for time (default 'hour').
  * @returns Human-readable string representing the date and time.
  */
 export function formatDateFriendly(date, timezone, { baseDate = new Date(), includeTz = true, timeFirst = false, dateOnly = false, timeOnly = false, maxPrecision = 'second', minPrecision = 'hour', } = {}) {
@@ -338,6 +343,12 @@ export function formatDateFriendly(date, timezone, { baseDate = new Date(), incl
  * @param end The end date and time.
  * @param timezone The time zone to use for formatting.
  * @param options Additional options for formatting the displayed date, taken from `formatDateFriendlyString()`.
+ * @param options.baseDate The base date to use for comparison (default is the current date).
+ * @param options.includeTz Whether to include the time zone in the output (default true).
+ * @param options.timeFirst If true, the time is shown before the date (default false).
+ * @param options.dateOnly If true, only the date is shown (default false).
+ * @param options.maxPrecision The maximum precision to show for time (default 'minute').
+ * @param options.minPrecision The minimum precision to always show for time (default 'hour').
  * @returns Human-readable string representing the datetime range.
  */
 export function formatDateRangeFriendly(start, end, timezone, { baseDate = new Date(), includeTz = true, timeFirst = false, dateOnly = false, maxPrecision = 'second', minPrecision = 'hour', } = {}) {

package/dist/date.js.map CHANGED Viewed

package/dist/interval.d.ts CHANGED Viewed

@@ -4,7 +4,7 @@ export declare const HOUR_IN_MILLISECONDS: number;
 export declare const DAY_IN_MILLISECONDS: number;
 /**
  * Makes an interval (in milliseconds).
- *
+ * @param param
  * @param param.days The number of days in the interval.
  * @param param.hours The number of hours in the interval.
  * @param param.minutes The number of minutes in the interval.
@@ -37,6 +37,7 @@ export declare function formatIntervalRelative(interval: number, prefix: 'Until'
  * Format an interval (in milliseconds) to a human-readable string like HH:MM or +HH:MM.
  *
  * @param interval Time interval in milliseconds.
+ * @param options
  * @param options.signed Whether to include the sign in the output.
  * @returns Human-readable string representing the interval in minutes.
  */

package/dist/interval.js CHANGED Viewed

@@ -4,7 +4,7 @@ export const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;
 export const DAY_IN_MILLISECONDS = 24 * HOUR_IN_MILLISECONDS;
 /**
  * Makes an interval (in milliseconds).
- *
+ * @param param
  * @param param.days The number of days in the interval.
  * @param param.hours The number of hours in the interval.
  * @param param.minutes The number of minutes in the interval.
@@ -70,6 +70,7 @@ export function formatIntervalRelative(interval, prefix, reference) {
  * Format an interval (in milliseconds) to a human-readable string like HH:MM or +HH:MM.
  *
  * @param interval Time interval in milliseconds.
+ * @param options
  * @param options.signed Whether to include the sign in the output.
  * @returns Human-readable string representing the interval in minutes.
  */

package/dist/interval.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"interval.js","sourceRoot":"","sources":["../src/interval.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAC3C,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAClE,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,oBAAoB,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,EAC3B,IAAI,GAAG,CAAC,EACR,KAAK,GAAG,CAAC,EACT,OAAO,GAAG,CAAC,EACX,OAAO,GAAG,CAAC,GAMZ;IACC,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,QAAgB;IAC7C,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAErC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,mBAAmB,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,oBAAoB,CAAC,GAAG,EAAE,CAAC;IACzE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAC1E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAE1E,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CACpC,QAAgB,EAChB,MAA2C,EAC3C,SAAiB;IAEjB,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACjB,OAAO,GAAG,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,UAAU,SAAS,EAAE,CAAC;IACpE,CAAC;SAAM,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,GAAG,MAAM,IAAI,cAAc,CAAC,CAAC,QAAQ,CAAC,WAAW,SAAS,EAAE,CAAC;IACtE,CAAC;SAAM,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,GAAG,MAAM,IAAI,SAAS,EAAE,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,OAAO,qBAAqB,QAAQ,EAAE,CAAC;IACzC,CAAC;AACH,CAAC;AAED~~;;;;;;GAMG~~;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAAgB,EAChB,EAAE,MAAM,GAAG,KAAK,KAA2B,EAAE,MAAM,EAAE,KAAK,EAAE;IAE5D,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1E,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,oBAAoB,CAAC,CAAC;IACpE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAC1E,OAAO,GAAG,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AAC3F,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAAgB;IACpD,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACrC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,sBAAsB,CAAC,CAAC,CAAC;IACvE,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;QAClB,OAAO,GAAG,IAAI,UAAU,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,IAAI,GAAG,OAAO,UAAU,CAAC;IACrC,CAAC;AACH,CAAC","sourcesContent":["export const SECOND_IN_MILLISECONDS = 1000;\nexport const MINUTE_IN_MILLISECONDS = 60 * SECOND_IN_MILLISECONDS;\nexport const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;\nexport const DAY_IN_MILLISECONDS = 24 * HOUR_IN_MILLISECONDS;\n\n/*\n Makes an interval (in milliseconds).\n \n @param param.days The number of days in the interval.\n * @param param.hours The number of hours in the interval.\n * @param param.minutes The number of minutes in the interval.\n * @param param.seconds The number of seconds in the interval.\n /\nexport function makeInterval({\n days = 0,\n hours = 0,\n minutes = 0,\n seconds = 0,\n}: {\n days?: number;\n hours?: number;\n minutes?: number;\n seconds?: number;\n}): number {\n return (((days 24 + hours) * 60 + minutes) * 60 + seconds) * 1000;\n}\n\n/*\n Format an interval (in milliseconds) to a human-readable string like '3 h 40 m'.\n \n @param interval Time interval in milliseconds.\n * @returns Human-readable string representing the interval.\n /\nexport function formatInterval(interval: number): string {\n const sign = interval < 0 ? '-' : '';\n\n const days = Math.floor(Math.abs(interval) / DAY_IN_MILLISECONDS);\n const hours = Math.floor(Math.abs(interval) / HOUR_IN_MILLISECONDS) % 24;\n const mins = Math.floor(Math.abs(interval) / MINUTE_IN_MILLISECONDS) % 60;\n const secs = Math.floor(Math.abs(interval) / SECOND_IN_MILLISECONDS) % 60;\n\n const parts: string[] = [];\n\n if (days > 0) {\n parts.push(`${sign}${days} d`);\n }\n if (hours > 0) {\n parts.push(`${sign}${hours} h`);\n }\n if (mins > 0) {\n parts.push(`${sign}${mins} min`);\n }\n if (secs > 0) {\n parts.push(`${sign}${secs} s`);\n }\n if (parts.length === 0) {\n parts.push('0 s');\n }\n\n return parts.join(' ');\n}\n\n/\n Format an interval (in milliseconds) to a human-readable string like 'Until 6\n * minutes before the session start time'.\n \n @param interval Time interval in milliseconds relative to `reference` (positive intervals are after `reference`).\n * @param prefix The prefix to use, must be 'Until' or 'From' (or lowercase versions of these).\n * @param reference The reference time, for example 'session start time'.\n * @returns Human-readable string representing the interval.\n /\nexport function formatIntervalRelative(\n interval: number,\n prefix: 'Until' \| 'until' \| 'From' \| 'from',\n reference: string,\n): string {\n if (interval > 0) {\n return `${prefix} ${formatInterval(interval)} after ${reference}`;\n } else if (interval < 0) {\n return `${prefix} ${formatInterval(-interval)} before ${reference}`;\n } else if (interval === 0) {\n return `${prefix} ${reference}`;\n } else {\n return `Invalid interval: ${interval}`;\n }\n}\n\n/\n Format an interval (in milliseconds) to a human-readable string like HH:MM or +HH:MM.\n \n @param interval Time interval in milliseconds.\n * @param options.signed Whether to include the sign in the output.\n * @returns Human-readable string representing the interval in minutes.\n /\nexport function formatIntervalHM(\n interval: number,\n { signed = false }: { signed?: boolean } = { signed: false },\n): string {\n const sign = interval < 0 ? '-' : interval > 0 ? (signed ? '+' : '') : '';\n const hours = Math.floor(Math.abs(interval) / HOUR_IN_MILLISECONDS);\n const mins = Math.floor(Math.abs(interval) / MINUTE_IN_MILLISECONDS) % 60;\n return `${sign}${hours.toString().padStart(2, '0')}:${mins.toString().padStart(2, '0')}`;\n}\n\n/\n Format an interval (in milliseconds) to a human-readable string with the number of minutes, like '7 minutes' or '1 minute'.\n \n @param interval Time interval in milliseconds.\n * @returns Human-readable string representing the interval in minutes.\n */\nexport function formatIntervalMinutes(interval: number): string {\n const sign = interval < 0 ? '-' : '';\n const minutes = Math.ceil(Math.abs(interval / MINUTE_IN_MILLISECONDS));\n if (minutes === 1) {\n return `${sign}1 minute`;\n } else {\n return `${sign}${minutes} minutes`;\n }\n}\n"]}
1	+ {"version":3,"file":"interval.js","sourceRoot":"","sources":["../src/interval.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,CAAC;AAC3C,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAClE,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,GAAG,sBAAsB,CAAC;AAChE,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,GAAG,oBAAoB,CAAC;AAE7D;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAAC,EAC3B,IAAI,GAAG,CAAC,EACR,KAAK,GAAG,CAAC,EACT,OAAO,GAAG,CAAC,EACX,OAAO,GAAG,CAAC,GAMZ;IACC,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,GAAG,KAAK,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,IAAI,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,QAAgB;IAC7C,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAErC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,mBAAmB,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,oBAAoB,CAAC,GAAG,EAAE,CAAC;IACzE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAC1E,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAE1E,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACd,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,KAAK,IAAI,CAAC,CAAC;IAClC,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,MAAM,CAAC,CAAC;IACnC,CAAC;IACD,IAAI,IAAI,GAAG,CAAC,EAAE,CAAC;QACb,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,IAAI,IAAI,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACzB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CACpC,QAAgB,EAChB,MAA2C,EAC3C,SAAiB;IAEjB,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACjB,OAAO,GAAG,MAAM,IAAI,cAAc,CAAC,QAAQ,CAAC,UAAU,SAAS,EAAE,CAAC;IACpE,CAAC;SAAM,IAAI,QAAQ,GAAG,CAAC,EAAE,CAAC;QACxB,OAAO,GAAG,MAAM,IAAI,cAAc,CAAC,CAAC,QAAQ,CAAC,WAAW,SAAS,EAAE,CAAC;IACtE,CAAC;SAAM,IAAI,QAAQ,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,GAAG,MAAM,IAAI,SAAS,EAAE,CAAC;IAClC,CAAC;SAAM,CAAC;QACN,OAAO,qBAAqB,QAAQ,EAAE,CAAC;IACzC,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,gBAAgB,CAC9B,QAAgB,EAChB,EAAE,MAAM,GAAG,KAAK,KAA2B,EAAE,MAAM,EAAE,KAAK,EAAE;IAE5D,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC1E,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,oBAAoB,CAAC,CAAC;IACpE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,sBAAsB,CAAC,GAAG,EAAE,CAAC;IAC1E,OAAO,GAAG,IAAI,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AAC3F,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAAgB;IACpD,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACrC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,GAAG,sBAAsB,CAAC,CAAC,CAAC;IACvE,IAAI,OAAO,KAAK,CAAC,EAAE,CAAC;QAClB,OAAO,GAAG,IAAI,UAAU,CAAC;IAC3B,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,IAAI,GAAG,OAAO,UAAU,CAAC;IACrC,CAAC;AACH,CAAC","sourcesContent":["export const SECOND_IN_MILLISECONDS = 1000;\nexport const MINUTE_IN_MILLISECONDS = 60 * SECOND_IN_MILLISECONDS;\nexport const HOUR_IN_MILLISECONDS = 60 * MINUTE_IN_MILLISECONDS;\nexport const DAY_IN_MILLISECONDS = 24 * HOUR_IN_MILLISECONDS;\n\n/*\n Makes an interval (in milliseconds).\n * @param param\n * @param param.days The number of days in the interval.\n * @param param.hours The number of hours in the interval.\n * @param param.minutes The number of minutes in the interval.\n * @param param.seconds The number of seconds in the interval.\n /\nexport function makeInterval({\n days = 0,\n hours = 0,\n minutes = 0,\n seconds = 0,\n}: {\n days?: number;\n hours?: number;\n minutes?: number;\n seconds?: number;\n}): number {\n return (((days 24 + hours) * 60 + minutes) * 60 + seconds) * 1000;\n}\n\n/*\n Format an interval (in milliseconds) to a human-readable string like '3 h 40 m'.\n \n @param interval Time interval in milliseconds.\n * @returns Human-readable string representing the interval.\n /\nexport function formatInterval(interval: number): string {\n const sign = interval < 0 ? '-' : '';\n\n const days = Math.floor(Math.abs(interval) / DAY_IN_MILLISECONDS);\n const hours = Math.floor(Math.abs(interval) / HOUR_IN_MILLISECONDS) % 24;\n const mins = Math.floor(Math.abs(interval) / MINUTE_IN_MILLISECONDS) % 60;\n const secs = Math.floor(Math.abs(interval) / SECOND_IN_MILLISECONDS) % 60;\n\n const parts: string[] = [];\n\n if (days > 0) {\n parts.push(`${sign}${days} d`);\n }\n if (hours > 0) {\n parts.push(`${sign}${hours} h`);\n }\n if (mins > 0) {\n parts.push(`${sign}${mins} min`);\n }\n if (secs > 0) {\n parts.push(`${sign}${secs} s`);\n }\n if (parts.length === 0) {\n parts.push('0 s');\n }\n\n return parts.join(' ');\n}\n\n/\n Format an interval (in milliseconds) to a human-readable string like 'Until 6\n * minutes before the session start time'.\n \n @param interval Time interval in milliseconds relative to `reference` (positive intervals are after `reference`).\n * @param prefix The prefix to use, must be 'Until' or 'From' (or lowercase versions of these).\n * @param reference The reference time, for example 'session start time'.\n * @returns Human-readable string representing the interval.\n /\nexport function formatIntervalRelative(\n interval: number,\n prefix: 'Until' \| 'until' \| 'From' \| 'from',\n reference: string,\n): string {\n if (interval > 0) {\n return `${prefix} ${formatInterval(interval)} after ${reference}`;\n } else if (interval < 0) {\n return `${prefix} ${formatInterval(-interval)} before ${reference}`;\n } else if (interval === 0) {\n return `${prefix} ${reference}`;\n } else {\n return `Invalid interval: ${interval}`;\n }\n}\n\n/\n Format an interval (in milliseconds) to a human-readable string like HH:MM or +HH:MM.\n \n @param interval Time interval in milliseconds.\n * @param options\n * @param options.signed Whether to include the sign in the output.\n * @returns Human-readable string representing the interval in minutes.\n /\nexport function formatIntervalHM(\n interval: number,\n { signed = false }: { signed?: boolean } = { signed: false },\n): string {\n const sign = interval < 0 ? '-' : interval > 0 ? (signed ? '+' : '') : '';\n const hours = Math.floor(Math.abs(interval) / HOUR_IN_MILLISECONDS);\n const mins = Math.floor(Math.abs(interval) / MINUTE_IN_MILLISECONDS) % 60;\n return `${sign}${hours.toString().padStart(2, '0')}:${mins.toString().padStart(2, '0')}`;\n}\n\n/\n Format an interval (in milliseconds) to a human-readable string with the number of minutes, like '7 minutes' or '1 minute'.\n \n @param interval Time interval in milliseconds.\n * @returns Human-readable string representing the interval in minutes.\n */\nexport function formatIntervalMinutes(interval: number): string {\n const sign = interval < 0 ? '-' : '';\n const minutes = Math.ceil(Math.abs(interval / MINUTE_IN_MILLISECONDS));\n if (minutes === 1) {\n return `${sign}1 minute`;\n } else {\n return `${sign}${minutes} minutes`;\n }\n}\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@prairielearn/formatter",
-  "version": "1.4.2",
+  "version": "1.4.4",
   "type": "module",
   "repository": {
     "type": "git",
@@ -19,10 +19,10 @@
   },
   "devDependencies": {
     "@prairielearn/tsconfig": "^0.0.0",
-    "@types/node": "^22.15.34",
+    "@types/node": "^22.17.0",
     "@vitest/coverage-v8": "^3.2.4",
     "tsx": "^4.20.3",
-    "typescript": "^5.8.3",
+    "typescript": "^5.9.2",
     "vitest": "^3.2.4"
   }
 }

package/src/date.ts CHANGED Viewed

@@ -8,8 +8,10 @@ type TimePrecision = 'hour' | 'minute' | 'second';
  *
  * @param date The date to format.
  * @param timeZone The time zone to use for formatting.
- * @param param2.includeTz Whether to include the time zone in the output (default true).
- * @param param2.longTz Whether to use the long time zone name (default false).
+ * @param options
+ * @param options.includeMs Whether to include milliseconds in the output (default false).
+ * @param options.includeTz Whether to include the time zone in the output (default true).
+ * @param options.longTz Whether to use the long time zone name (default false).
  * @returns Human-readable string representing the date.
  */
 export function formatDate(
@@ -105,7 +107,8 @@ export function formatTz(timeZone: string): string {
  *
  * @param date The date to format.
  * @param timeZone The time zone to use for formatting.
- * @param param2.includeTz Whether to include the time zone in the output (default true).
+ * @param options
+ * @param options.includeTz Whether to include the time zone in the output (default true).
  * @returns Human-readable string representing the date.
  */
 export function formatDateHMS(
@@ -301,7 +304,8 @@ function formatDateFriendlyParts(
     throw new Error('maxPrecision must be an equal or smaller unit than minPrecision.');
   }
-  /** Examples:
+  /**
+   * Examples:
    * min=h, max=h: 0:00:00AM -> 0AM, 0:00:01AM -> 0AM, 0:01:01AM -> 0AM
    * min=h, max=m: 0:00:00AM -> 0AM, 0:00:01AM -> 0AM, 0:01:01AM -> 0:01AM
    * min=h, max=s: 0:00:00AM -> 0AM, 0:00:01AM -> 0:00:01AM, 0:01:01AM -> 0:01:01AM
@@ -359,13 +363,14 @@ function formatDateFriendlyParts(
  *
  * @param date The date to format.
  * @param timezone The time zone to use for formatting.
- * @param param.baseDate The base date to use for comparison (default is the current date).
- * @param param.includeTz Whether to include the time zone in the output (default true).
- * @param param.timeFirst If true, the time is shown before the date (default false).
- * @param param.dateOnly If true, only the date is shown (default false).
- * @param param.timeOnly If true, only the time is shown (default false).
- * @param param.maxPrecision The maximum precision to show for time (default 'minute').
- * @param param.minPrecision The minimum precision to always show for time (default 'hour').
+ * @param options
+ * @param options.baseDate The base date to use for comparison (default is the current date).
+ * @param options.includeTz Whether to include the time zone in the output (default true).
+ * @param options.timeFirst If true, the time is shown before the date (default false).
+ * @param options.dateOnly If true, only the date is shown (default false).
+ * @param options.timeOnly If true, only the time is shown (default false).
+ * @param options.maxPrecision The maximum precision to show for time (default 'minute').
+ * @param options.minPrecision The minimum precision to always show for time (default 'hour').
  * @returns Human-readable string representing the date and time.
  */
 export function formatDateFriendly(
@@ -430,6 +435,12 @@ export function formatDateFriendly(
  * @param end The end date and time.
  * @param timezone The time zone to use for formatting.
  * @param options Additional options for formatting the displayed date, taken from `formatDateFriendlyString()`.
+ * @param options.baseDate The base date to use for comparison (default is the current date).
+ * @param options.includeTz Whether to include the time zone in the output (default true).
+ * @param options.timeFirst If true, the time is shown before the date (default false).
+ * @param options.dateOnly If true, only the date is shown (default false).
+ * @param options.maxPrecision The maximum precision to show for time (default 'minute').
+ * @param options.minPrecision The minimum precision to always show for time (default 'hour').
  * @returns Human-readable string representing the datetime range.
  */
 export function formatDateRangeFriendly(

package/src/interval.ts CHANGED Viewed

@@ -5,7 +5,7 @@ export const DAY_IN_MILLISECONDS = 24 * HOUR_IN_MILLISECONDS;
 /**
  * Makes an interval (in milliseconds).
- *
+ * @param param
  * @param param.days The number of days in the interval.
  * @param param.hours The number of hours in the interval.
  * @param param.minutes The number of minutes in the interval.
@@ -89,6 +89,7 @@ export function formatIntervalRelative(
  * Format an interval (in milliseconds) to a human-readable string like HH:MM or +HH:MM.
  *
  * @param interval Time interval in milliseconds.
+ * @param options
  * @param options.signed Whether to include the sign in the output.
  * @returns Human-readable string representing the interval in minutes.
  */