@cityssm/utils-datetime 1.1.2 → 1.1.3

package/dateIntegerToDate.ts

@@ -17,9 +17,9 @@ export function dateIntegerToDate(
 ): undefined
 
 /**
- * @param {number | undefined | null} dateInteger - A number representing a date (ex. 20241231)
- * @param {number} timeInteger - A number representing a time (ex. 2359)
- * @returns {Date | undefined} - A Date object (ex. '2024-12-31 23:59')
+ * @param dateInteger - A number representing a date (ex. 20241231)
+ * @param timeInteger - A number representing a time (ex. 2359)
+ * @returns - A Date object (ex. '2024-12-31 23:59')
  */
 export function dateIntegerToDate(
   dateInteger: number | undefined | null,

package/dateIntegerToString.ts

@@ -12,8 +12,8 @@ export function dateIntegerToString(dateInteger: null | undefined | 0): ''
 
 /**
  * Formats a date number as a string.
- * @param {number | undefined | null} dateInteger - A number representing a date.
- * @returns {DateString | ''} - A string representing a date.
+ * @param dateInteger - A number representing a date.
+ * @returns - A string representing a date.
  */
 export function dateIntegerToString(
   dateInteger: number | undefined | null

package/dateStringToDate.ts

@@ -3,13 +3,13 @@ import { isValidTimeString } from './isValidTimeString.js'
 
 /**
  * Formats a string date and time as a JavaScript Date object.
- * @param {string} dateString - A string representing a date.
- * @param {string} timeString - A string representing a time.
- * @returns {Date} - A JavaScript Date object.
+ * @param dateString - A string representing a date.
+ * @param timeString - A string representing a time.
+ * @returns - A JavaScript Date object.
  */
 export function dateStringToDate(
   dateString: string,
-  timeString: string = '00:00'
+  timeString = '00:00'
 ): Date | undefined {
   if (!isValidDateString(dateString) || !isValidTimeString(timeString)) {
     return undefined

package/dateStringToInteger.ts

@@ -4,8 +4,8 @@ import { isValidDateString } from './isValidDateString.js'
 
 /**
  * Formats a date string as a number.
- * @param {string} dateString - A date formatted as a string (ex. '2024-12-31')
- * @returns {number} - A number representing a date.
+ * @param dateString - A date formatted as a string (ex. '2024-12-31')
+ * @returns - A number representing a date.
  */
 export function dateStringToInteger(dateString: string): number | undefined {
   if (!isValidDateString(dateString)) {

package/dateToInteger.js

@@ -2,7 +2,7 @@ export function dateToInteger(dateObject) {
     if (dateObject === undefined) {
         return undefined;
     }
-    return (dateObject.getFullYear() * 10000 +
+    return (dateObject.getFullYear() * 10_000 +
         (dateObject.getMonth() + 1) * 100 +
         dateObject.getDate());
 }

package/dateToInteger.ts

@@ -5,8 +5,8 @@ export function dateToInteger(dateObject: undefined): undefined
 
 /**
  * Formats a JavaScript Date object as a number.
- * @param {Date} dateObject - A JavaScript Date object.
- * @returns {number} - A number representing the date.
+ * @param dateObject - A JavaScript Date object.
+ * @returns - A number representing the date.
  */
 export function dateToInteger(
   dateObject: Date | undefined

package/dateToString.ts

@@ -9,8 +9,8 @@ export function dateToString(dateObject: undefined): ''
 
 /**
  * Formats a JavaScript Date object as a date string.
- * @param {Date} dateObject - A JavaScript Date object
- * @returns {DateString} A date string.
+ * @param dateObject - A JavaScript Date object
+ * @returns - A date string.
  */
 export function dateToString(dateObject: Date | undefined): DateString | '' {
   if (dateObject === undefined) {

package/dateToTimeInteger.ts

@@ -7,8 +7,8 @@ export function dateToTimeInteger(dateObject: undefined): undefined
 
 /**
  * Formats the time in a JavaScript Date as a number.
- * @param {Date} dateObject - A JavaScript Date object.
- * @returns {number} - A number representing a time.
+ * @param dateObject - A JavaScript Date object.
+ * @returns - A number representing a time.
  */
 export function dateToTimeInteger(
   dateObject: Date | undefined

package/dateToTimePeriodString.ts

@@ -9,8 +9,8 @@ export function dateToTimePeriodString(dateObject: undefined): ''
 
 /**
  * Formats a JavaScript Date as a time period string.
- * @param {Date} dateObject - A JavaScript Date object.
- * @returns {TimePeriodString} - A time string formatted with the time period (ex. 1:23 a.m.)
+ * @param dateObject - A JavaScript Date object.
+ * @returns - A time string formatted with the time period (ex. 1:23 a.m.)
  */
 export function dateToTimePeriodString(
   dateObject: Date | undefined

package/dateToTimeString.ts

@@ -9,8 +9,8 @@ export function dateToTimeString(dateObject: undefined): ''
 
 /**
  * Formats a JavaScript Date object as a time string.
- * @param {Date} dateObject - A JavaScript Date object.
- * @returns {TimeString} - A string representing the time.
+ * @param dateObject - A JavaScript Date object.
+ * @returns - A string representing the time.
  */
 export function dateToTimeString(
   dateObject: Date | undefined

package/isValidDateInteger.ts

@@ -1,7 +1,7 @@
 /**
  * Determines if a number is a valid date number.
- * @param {unknown} possibleDateInteger - A possible date number
- * @returns {boolean} - True if the possible date integer is valid.
+ * @param possibleDateInteger - A possible date number
+ * @returns - True if the possible date integer is valid.
  */
 export function isValidDateInteger(
   possibleDateInteger: unknown

package/isValidDateString.ts

@@ -4,8 +4,8 @@ const dateStringRegex = /^\d{4}-[01]\d-[0-3]\d$/
 
 /**
  * Determines if a string is a valid date string.
- * @param {unknown} possibleDateString - A possible date string
- * @returns {boolean} - True when the possible date string is valid
+ * @param possibleDateString - A possible date string
+ * @returns - True when the possible date string is valid
  */
 export function isValidDateString(
   possibleDateString: unknown

package/isValidTimeInteger.ts

@@ -1,7 +1,7 @@
 /**
  * Determines if a number is a valid time number.
- * @param {unknown} possibleTimeInteger - A possible time number
- * @returns {boolean} - True if the possible time integer is valid.
+ * @param possibleTimeInteger - A possible time number
+ * @returns - True if the possible time integer is valid.
  */
 export function isValidTimeInteger(
   possibleTimeInteger: unknown

package/isValidTimeString.ts

@@ -4,8 +4,8 @@ const timeStringRegex = /^[01]\d:[0-5]\d$/
 
 /**
  * Determines if a string is a valid time string.
- * @param {unknown} possibleTimeString - A possible time string.
- * @returns {boolean} - True when the possible time string is valid.
+ * @param possibleTimeString - A possible time string.
+ * @returns - True when the possible time string is valid.
  */
 export function isValidTimeString(
   possibleTimeString: unknown

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cityssm/utils-datetime",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "Date time utilities for Node.js applications",
   "keywords": [
     "date",
@@ -25,14 +25,14 @@
     "test": "test"
   },
   "scripts": {
-    "test": "mocha",
-    "coverage": "c8 mocha"
+    "test": "node --test",
+    "coverage": "c8 --reporter=lcov --reporter=text --reporter=text-summary node --test"
   },
   "author": "The Corporation of the City of Sault Ste. Marie",
   "license": "MIT",
   "devDependencies": {
-    "@types/mocha": "^10.0.6",
-    "@types/node": "^20.11.19",
-    "eslint-config-cityssm": "^1.4.1"
+    "@types/node": "^20.14.5",
+    "eslint-config-cityssm": "^5.0.0",
+    "prettier-config-cityssm": "^1.0.0"
   }
 }

package/timeIntegerToPeriodString.d.ts

@@ -1,2 +1,2 @@
 import type { TimePeriodString } from './dateTimeTypes.js';
-export declare function timeIntegerToPeriodString(timeInteger?: number): TimePeriodString | '';
+export declare function timeIntegerToPeriodString(timeInteger?: number | undefined | null): TimePeriodString | '';

package/timeIntegerToPeriodString.js

@@ -1,5 +1,5 @@
 import { dateIntegerToDate } from './dateIntegerToDate.js';
 import { dateToTimePeriodString } from './dateToTimePeriodString.js';
 export function timeIntegerToPeriodString(timeInteger = 0) {
-    return dateToTimePeriodString(dateIntegerToDate(19700101, timeInteger));
+    return dateToTimePeriodString(dateIntegerToDate(19700101, timeInteger ?? 0));
 }

package/timeIntegerToPeriodString.ts

@@ -4,12 +4,12 @@ import { dateToTimePeriodString } from './dateToTimePeriodString.js'
 
 /**
  * Formats a time represented as a number as a string.
- * @param {number} timeInteger - A number representing a time.
- * @returns {TimePeriodString} - A string representing a time.
+ * @param timeInteger - A number representing a time.
+ * @returns - A string representing a time.
  */
 export function timeIntegerToPeriodString(
-  timeInteger: number = 0
+  timeInteger: number | undefined | null = 0
 ): TimePeriodString | '' {
   // eslint-disable-next-line unicorn/numeric-separators-style
-  return dateToTimePeriodString(dateIntegerToDate(19700101, timeInteger))
+  return dateToTimePeriodString(dateIntegerToDate(19700101, timeInteger ?? 0))
 }

package/timeIntegerToString.ts

@@ -2,8 +2,8 @@ import type { TimeString } from './dateTimeTypes.js'
 
 /**
  * Formats a number representing a time as a string.
- * @param {number} timeInteger - A number representing a time.
- * @returns {TimeString} - A string representing a time.
+ * @param timeInteger - A number representing a time.
+ * @returns - A string representing a time.
  */
 export function timeIntegerToString(
   timeInteger: number | undefined | null

package/timeStringToInteger.ts

@@ -2,8 +2,8 @@ import { isValidTimeString } from './isValidTimeString.js'
 
 /**
  * Formats a string representing a time as a number.
- * @param {string} timeString - A string representing a time.
- * @returns {number} - A number representing a time.
+ * @param timeString - A string representing a time.
+ * @returns - A number representing a time.
  */
 export function timeStringToInteger(timeString: string): number | undefined {
   if (!isValidTimeString(timeString)) {