@cityssm/utils-datetime 1.0.0 → 1.1.0

package/README.md

@@ -1,7 +1,7 @@
 # node-utils-datetime
 
 [![npm (scoped)](https://img.shields.io/npm/v/@cityssm/utils-datetime)](https://www.npmjs.com/package/@cityssm/utils-datetime)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/06418cae779f4c2c9657136dd60c0809)](https://app.codacy.com/gh/cityssm/node-utils-datetime/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![DeepSource](https://app.deepsource.com/gh/cityssm/node-utils-datetime.svg/?label=active+issues&show_trend=true&token=Qxl72G0xqdKZdqcKOm8Jg-Dt)](https://app.deepsource.com/gh/cityssm/node-utils-datetime/)
 [![Maintainability](https://api.codeclimate.com/v1/badges/6f6f8ed35487ab5f36a5/maintainability)](https://codeclimate.com/github/cityssm/node-utils-datetime/maintainability)
 [![codecov](https://codecov.io/gh/cityssm/node-utils-datetime/branch/main/graph/badge.svg?token=3E8VHNL34S)](https://codecov.io/gh/cityssm/node-utils-datetime)
 

package/dateIntegerToDate.js

@@ -1,11 +1,9 @@
+import { isValidDateInteger } from './isValidDateInteger.js';
 export function dateIntegerToDate(dateInteger, timeInteger = 0) {
-    if (dateInteger === null ||
-        dateInteger === undefined ||
-        Number.isNaN(dateInteger) ||
-        dateInteger === 0) {
-        return;
+    if (!isValidDateInteger(dateInteger)) {
+        return undefined;
     }
-    const dateString = ('00000000' + dateInteger.toString()).slice(-8);
-    const timeString = ('0000' + (timeInteger ?? 0).toString()).slice(-4);
+    const dateString = `00000000${dateInteger.toString()}`.slice(-8);
+    const timeString = `0000${(timeInteger ?? 0).toString()}`.slice(-4);
     return new Date(Number.parseInt(dateString.slice(0, 4), 10), Number.parseInt(dateString.slice(4, 6), 10) - 1, Number.parseInt(dateString.slice(6, 8), 10), Number.parseInt(timeString.slice(0, 2), 10), Number.parseInt(timeString.slice(2, 4), 10));
 }

package/dateIntegerToDate.ts

@@ -1,3 +1,5 @@
+import { isValidDateInteger } from './isValidDateInteger.js'
+
 export function dateIntegerToDate(
   dateInteger: number,
   timeInteger?: number
@@ -7,22 +9,22 @@ export function dateIntegerToDate(
   timeInteger?: number
 ): 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')
+ */
 export function dateIntegerToDate(
   dateInteger: number | undefined | null,
-  timeInteger = 0
+  timeInteger: number | undefined | null = 0
 ): Date | undefined {
-  if (
-    dateInteger === null ||
-    dateInteger === undefined ||
-    Number.isNaN(dateInteger) ||
-    dateInteger === 0
-  ) {
-    return
+  if (!isValidDateInteger(dateInteger)) {
+    return undefined
   }
 
-  const dateString = ('00000000' + dateInteger.toString()).slice(-8)
+  const dateString = `00000000${(dateInteger as number).toString()}`.slice(-8)
 
-  const timeString = ('0000' + (timeInteger ?? 0).toString()).slice(-4)
+  const timeString = `0000${(timeInteger ?? 0).toString()}`.slice(-4)
 
   return new Date(
     Number.parseInt(dateString.slice(0, 4), 10),

package/dateIntegerToString.d.ts

@@ -1,2 +1,3 @@
-export declare function dateIntegerToString(dateInteger: number): string;
+import type { DateString } from './dateTimeTypes.js';
+export declare function dateIntegerToString(dateInteger: number): DateString;
 export declare function dateIntegerToString(dateInteger: null | undefined | 0): '';

package/dateIntegerToString.js

@@ -1,10 +1,8 @@
 import { dateIntegerToDate } from './dateIntegerToDate.js';
 import { dateToString } from './dateToString.js';
+import { isValidDateInteger } from './isValidDateInteger.js';
 export function dateIntegerToString(dateInteger) {
-    if (dateInteger === null ||
-        dateInteger === undefined ||
-        Number.isNaN(dateInteger) ||
-        dateInteger === 0) {
+    if (!isValidDateInteger(dateInteger)) {
         return '';
     }
     return dateToString(dateIntegerToDate(dateInteger));

package/dateIntegerToString.ts

@@ -1,20 +1,22 @@
 import { dateIntegerToDate } from './dateIntegerToDate.js'
+import type { DateString } from './dateTimeTypes.js'
 import { dateToString } from './dateToString.js'
+import { isValidDateInteger } from './isValidDateInteger.js'
 
-export function dateIntegerToString(dateInteger: number): string
+export function dateIntegerToString(dateInteger: number): DateString
 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.
+ */
 export function dateIntegerToString(
   dateInteger: number | undefined | null
-): string | undefined {
-  if (
-    dateInteger === null ||
-    dateInteger === undefined ||
-    Number.isNaN(dateInteger) ||
-    dateInteger === 0
-  ) {
+): DateString | '' {
+  if (!isValidDateInteger(dateInteger)) {
     return ''
   }
 
-  return dateToString(dateIntegerToDate(dateInteger))
+  return dateToString(dateIntegerToDate(dateInteger as number))
 }

package/dateStringToDate.d.ts

@@ -1 +1,2 @@
-export declare function dateStringToDate(dateString: string, timeString?: string): Date;
+import type { DateString, TimeString } from './dateTimeTypes.js';
+export declare function dateStringToDate(dateString: DateString, timeString?: TimeString): Date;

package/dateStringToDate.ts

@@ -1,6 +1,14 @@
+import type { DateString, TimeString } from './dateTimeTypes.js'
+
+/**
+ * Formats a string date and time as a JavaScript Date object.
+ * @param {DateString} dateString - A string representing a date.
+ * @param {TimeString} timeString - A string representing a time.
+ * @returns {Date} - A JavaScript Date object.
+ */
 export function dateStringToDate(
-  dateString: string,
-  timeString = '00:00'
+  dateString: DateString,
+  timeString: TimeString = '00:00'
 ): Date {
   const datePieces = dateString.split('-')
   const timePieces = timeString.split(':')

package/dateStringToInteger.d.ts

@@ -1 +1,2 @@
-export declare function dateStringToInteger(dateString: string): number;
+import type { DateString } from './dateTimeTypes.js';
+export declare function dateStringToInteger(dateString: DateString): number;

package/dateStringToInteger.ts

@@ -1,6 +1,12 @@
 import { dateStringToDate } from './dateStringToDate.js'
+import type { DateString } from './dateTimeTypes.js'
 import { dateToInteger } from './dateToInteger.js'
 
-export function dateStringToInteger(dateString: string): number {
+/**
+ * Formats a date string as a number.
+ * @param {DateString} dateString - A date formatted as a string (ex. '2024-12-31')
+ * @returns {number} - A number representing a date.
+ */
+export function dateStringToInteger(dateString: DateString): number {
   return dateToInteger(dateStringToDate(dateString))
 }

package/dateTimeTypes.d.ts

@@ -0,0 +1,3 @@
+export type DateString = `${number}-${number}-${number}`;
+export type TimeString = `${number}:${number}`;
+export type TimePeriodString = `${number}:${number} ${'a.m.' | 'p.m.'}`;

package/dateTimeTypes.js

@@ -0,0 +1 @@
+export {};

package/dateTimeTypes.ts

@@ -0,0 +1,14 @@
+/**
+ * yyyy-mm-dd
+ */
+export type DateString = `${number}-${number}-${number}`
+
+/**
+ * hh:mm
+ */
+export type TimeString = `${number}:${number}`
+
+/**
+ * h:mm a.m. | h:mm p.m.
+ */
+export type TimePeriodString = `${number}:${number} ${'a.m.' | 'p.m.'}`

package/dateToInteger.ts

@@ -1,3 +1,8 @@
+/**
+ * Formats a JavaScript Date object as a number.
+ * @param {Date} dateObject - A JavaScript Date object.
+ * @returns {number} - A number representing the date.
+ */
 export function dateToInteger(dateObject: Date): number {
   return (
     dateObject.getFullYear() * 10_000 +

package/dateToString.d.ts

@@ -1 +1,2 @@
-export declare function dateToString(dateObject: Date): string;
+import type { DateString } from './dateTimeTypes.js';
+export declare function dateToString(dateObject: Date): DateString;

package/dateToString.ts

@@ -1,7 +1,14 @@
-export function dateToString(dateObject: Date): string {
+import type { DateString } from './dateTimeTypes.js'
+
+/**
+ * Formats a JavaScript Date object as a date string.
+ * @param {Date} dateObject - A JavaScript Date object
+ * @returns {DateString} A date string.
+ */
+export function dateToString(dateObject: Date): DateString {
   return Intl.DateTimeFormat('fr-CA', {
     year: 'numeric',
     month: '2-digit',
     day: '2-digit'
-  }).format(dateObject)
+  }).format(dateObject) as DateString
 }

package/dateToTimeInteger.ts

@@ -1,3 +1,8 @@
+/**
+ * Formats the time in a JavaScript Date as a number.
+ * @param {Date} dateObject - A JavaString Date object.
+ * @returns {number} - A number representing a time.
+ */
 export function dateToTimeInteger(dateObject: Date): number {
   return dateObject.getHours() * 100 + dateObject.getMinutes()
 }

package/dateToTimePeriodString.d.ts

@@ -1 +1,2 @@
-export declare function dateToTimePeriodString(dateObject: Date): string;
+import type { TimePeriodString } from './dateTimeTypes.js';
+export declare function dateToTimePeriodString(dateObject: Date): TimePeriodString;

package/dateToTimePeriodString.ts

@@ -1,9 +1,16 @@
-export function dateToTimePeriodString(dateObject: Date): string {
+import type { TimePeriodString } from './dateTimeTypes.js'
+
+/**
+ * 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.)
+ */
+export function dateToTimePeriodString(dateObject: Date): TimePeriodString {
   return Intl.DateTimeFormat('en-CA', {
     hourCycle: 'h12',
     hour: 'numeric',
     minute: '2-digit'
   })
     .format(dateObject)
-    .replaceAll('\u202F', ' ')
+    .replaceAll('\u202F', ' ') as TimePeriodString
 }

package/dateToTimeString.d.ts

@@ -1 +1,2 @@
-export declare function dateToTimeString(dateObject: Date): string;
+import type { TimeString } from './dateTimeTypes.js';
+export declare function dateToTimeString(dateObject: Date): TimeString;

package/dateToTimeString.ts

@@ -1,7 +1,14 @@
-export function dateToTimeString(dateObject: Date): string {
+import type { TimeString } from './dateTimeTypes.js'
+
+/**
+ * Formats a JavaScript Date object as a time string.
+ * @param {Date} dateObject - A JavaScript Date object.
+ * @returns {TimeString} - A string representing the time.
+ */
+export function dateToTimeString(dateObject: Date): TimeString {
   return Intl.DateTimeFormat('en-CA', {
     hourCycle: 'h24',
     hour: '2-digit',
     minute: '2-digit'
-  }).format(dateObject)
+  }).format(dateObject) as TimeString
 }

package/index.d.ts

@@ -7,6 +7,10 @@ import { dateToString } from './dateToString.js';
 import { dateToTimeInteger } from './dateToTimeInteger.js';
 import { dateToTimePeriodString } from './dateToTimePeriodString.js';
 import { dateToTimeString } from './dateToTimeString.js';
+import { isValidDateInteger } from './isValidDateInteger.js';
+import { isValidDateString } from './isValidDateString.js';
+import { isValidTimeInteger } from './isValidTimeInteger.js';
+import { isValidTimeString } from './isValidTimeString.js';
 import { timeIntegerToPeriodString } from './timeIntegerToPeriodString.js';
 import { timeIntegerToString } from './timeIntegerToString.js';
 import { timeStringToInteger } from './timeStringToInteger.js';
@@ -24,6 +28,11 @@ export { dateToTimePeriodString } from './dateToTimePeriodString.js';
 export { timeIntegerToString } from './timeIntegerToString.js';
 export { timeIntegerToPeriodString } from './timeIntegerToPeriodString.js';
 export { timeStringToInteger } from './timeStringToInteger.js';
+export type { DateString, TimeString, TimePeriodString } from './dateTimeTypes.js';
+export { isValidDateInteger } from './isValidDateInteger.js';
+export { isValidDateString } from './isValidDateString.js';
+export { isValidTimeInteger } from './isValidTimeInteger.js';
+export { isValidTimeString } from './isValidTimeString.js';
 declare const _default: {
     months: string[];
     days: string[];
@@ -36,6 +45,10 @@ declare const _default: {
     dateToTimeInteger: typeof dateToTimeInteger;
     dateToTimeString: typeof dateToTimeString;
     dateToTimePeriodString: typeof dateToTimePeriodString;
+    isValidDateInteger: typeof isValidDateInteger;
+    isValidDateString: typeof isValidDateString;
+    isValidTimeInteger: typeof isValidTimeInteger;
+    isValidTimeString: typeof isValidTimeString;
     timeIntegerToString: typeof timeIntegerToString;
     timeIntegerToPeriodString: typeof timeIntegerToPeriodString;
     timeStringToInteger: typeof timeStringToInteger;

package/index.js

@@ -7,6 +7,10 @@ import { dateToString } from './dateToString.js';
 import { dateToTimeInteger } from './dateToTimeInteger.js';
 import { dateToTimePeriodString } from './dateToTimePeriodString.js';
 import { dateToTimeString } from './dateToTimeString.js';
+import { isValidDateInteger } from './isValidDateInteger.js';
+import { isValidDateString } from './isValidDateString.js';
+import { isValidTimeInteger } from './isValidTimeInteger.js';
+import { isValidTimeString } from './isValidTimeString.js';
 import { timeIntegerToPeriodString } from './timeIntegerToPeriodString.js';
 import { timeIntegerToString } from './timeIntegerToString.js';
 import { timeStringToInteger } from './timeStringToInteger.js';
@@ -45,6 +49,10 @@ export { dateToTimePeriodString } from './dateToTimePeriodString.js';
 export { timeIntegerToString } from './timeIntegerToString.js';
 export { timeIntegerToPeriodString } from './timeIntegerToPeriodString.js';
 export { timeStringToInteger } from './timeStringToInteger.js';
+export { isValidDateInteger } from './isValidDateInteger.js';
+export { isValidDateString } from './isValidDateString.js';
+export { isValidTimeInteger } from './isValidTimeInteger.js';
+export { isValidTimeString } from './isValidTimeString.js';
 export default {
     months,
     days,
@@ -57,6 +65,10 @@ export default {
     dateToTimeInteger,
     dateToTimeString,
     dateToTimePeriodString,
+    isValidDateInteger,
+    isValidDateString,
+    isValidTimeInteger,
+    isValidTimeString,
     timeIntegerToString,
     timeIntegerToPeriodString,
     timeStringToInteger

package/index.ts

@@ -7,6 +7,10 @@ import { dateToString } from './dateToString.js'
 import { dateToTimeInteger } from './dateToTimeInteger.js'
 import { dateToTimePeriodString } from './dateToTimePeriodString.js'
 import { dateToTimeString } from './dateToTimeString.js'
+import { isValidDateInteger } from './isValidDateInteger.js'
+import { isValidDateString } from './isValidDateString.js'
+import { isValidTimeInteger } from './isValidTimeInteger.js'
+import { isValidTimeString } from './isValidTimeString.js'
 import { timeIntegerToPeriodString } from './timeIntegerToPeriodString.js'
 import { timeIntegerToString } from './timeIntegerToString.js'
 import { timeStringToInteger } from './timeStringToInteger.js'
@@ -68,6 +72,19 @@ export { timeIntegerToPeriodString } from './timeIntegerToPeriodString.js'
 // From Time String
 export { timeStringToInteger } from './timeStringToInteger.js'
 
+// Types
+export type {
+  DateString,
+  TimeString,
+  TimePeriodString
+} from './dateTimeTypes.js'
+
+// Validators
+export { isValidDateInteger } from './isValidDateInteger.js'
+export { isValidDateString } from './isValidDateString.js'
+export { isValidTimeInteger } from './isValidTimeInteger.js'
+export { isValidTimeString } from './isValidTimeString.js'
+
 export default {
   months,
   days,
@@ -80,6 +97,10 @@ export default {
   dateToTimeInteger,
   dateToTimeString,
   dateToTimePeriodString,
+  isValidDateInteger,
+  isValidDateString,
+  isValidTimeInteger,
+  isValidTimeString,
   timeIntegerToString,
   timeIntegerToPeriodString,
   timeStringToInteger

package/isValidDateInteger.d.ts

@@ -0,0 +1 @@
+export declare function isValidDateInteger(possibleDateInteger: unknown): boolean;

package/isValidDateInteger.js

@@ -0,0 +1,5 @@
+export function isValidDateInteger(possibleDateInteger) {
+    return (typeof possibleDateInteger === 'number' &&
+        possibleDateInteger >= 101 &&
+        possibleDateInteger % 1 === 0);
+}

package/isValidDateInteger.ts

@@ -0,0 +1,12 @@
+/**
+ * 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.
+ */
+export function isValidDateInteger(possibleDateInteger: unknown): boolean {
+  return (
+    typeof possibleDateInteger === 'number' &&
+    possibleDateInteger >= 101 &&
+    possibleDateInteger % 1 === 0
+  )
+}

package/isValidDateString.d.ts

@@ -0,0 +1 @@
+export declare function isValidDateString(possibleDateString: unknown): boolean;

package/isValidDateString.js

@@ -0,0 +1,6 @@
+const dateStringRegex = /^\d{4}-[01]\d-[0-3]\d$/;
+export function isValidDateString(possibleDateString) {
+    return (typeof possibleDateString === 'string' &&
+        (possibleDateString ?? '').length === 10 &&
+        dateStringRegex.test(possibleDateString));
+}

package/isValidDateString.ts

@@ -0,0 +1,14 @@
+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
+ */
+export function isValidDateString(possibleDateString: unknown): boolean {
+  return (
+    typeof possibleDateString === 'string' &&
+    (possibleDateString ?? '').length === 10 &&
+    dateStringRegex.test(possibleDateString)
+  )
+}

package/isValidTimeInteger.d.ts

@@ -0,0 +1 @@
+export declare function isValidTimeInteger(possibleTimeInteger: unknown): boolean;

package/isValidTimeInteger.js

@@ -0,0 +1,6 @@
+export function isValidTimeInteger(possibleTimeInteger) {
+    return (typeof possibleTimeInteger === 'number' &&
+        possibleTimeInteger >= 0 &&
+        possibleTimeInteger <= 2359 &&
+        possibleTimeInteger % 1 === 0);
+}

package/isValidTimeInteger.ts

@@ -0,0 +1,13 @@
+/**
+ * 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.
+ */
+export function isValidTimeInteger(possibleTimeInteger: unknown): boolean {
+  return (
+    typeof possibleTimeInteger === 'number' &&
+    possibleTimeInteger >= 0 &&
+    possibleTimeInteger <= 2359 &&
+    possibleTimeInteger % 1 === 0
+  )
+}

package/isValidTimeString.d.ts

@@ -0,0 +1 @@
+export declare function isValidTimeString(possibleTimeString: unknown): boolean;

package/isValidTimeString.js

@@ -0,0 +1,6 @@
+const timeStringRegex = /^[01]\d:[0-5]\d$/;
+export function isValidTimeString(possibleTimeString) {
+    return (typeof possibleTimeString === 'string' &&
+        (possibleTimeString ?? '').length === 5 &&
+        timeStringRegex.test(possibleTimeString));
+}

package/isValidTimeString.ts

@@ -0,0 +1,14 @@
+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.
+ */
+export function isValidTimeString(possibleTimeString: unknown): boolean {
+  return (
+    typeof possibleTimeString === 'string' &&
+    (possibleTimeString ?? '').length === 5 &&
+    timeStringRegex.test(possibleTimeString)
+  )
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cityssm/utils-datetime",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Date time utilities for Node.js applications",
   "keywords": [
     "date",
@@ -32,7 +32,7 @@
   "license": "MIT",
   "devDependencies": {
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.10.0",
-    "eslint-config-cityssm": "^1.0.0"
+    "@types/node": "^20.11.19",
+    "eslint-config-cityssm": "^1.4.1"
   }
 }

package/timeIntegerToPeriodString.d.ts

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

package/timeIntegerToPeriodString.ts

@@ -1,7 +1,15 @@
 import { dateIntegerToDate } from './dateIntegerToDate.js'
+import type { TimePeriodString } from './dateTimeTypes.js'
 import { dateToTimePeriodString } from './dateToTimePeriodString.js'
 
-export function timeIntegerToPeriodString(timeInteger: number): string {
+/**
+ * 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.
+ */
+export function timeIntegerToPeriodString(
+  timeInteger: number
+): TimePeriodString {
   // eslint-disable-next-line unicorn/numeric-separators-style
   return dateToTimePeriodString(dateIntegerToDate(19700101, timeInteger))
 }

package/timeIntegerToString.d.ts

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

package/timeIntegerToString.js

@@ -1,4 +1,4 @@
 export function timeIntegerToString(timeInteger) {
-    const timeString = ('0000' + (timeInteger ?? 0).toString()).slice(-4);
-    return timeString.slice(0, 2) + ':' + timeString.slice(2, 4);
+    const timeString = `0000${(timeInteger ?? 0).toString()}`.slice(-4);
+    return `${timeString.slice(0, 2)}:${timeString.slice(2, 4)}`;
 }

package/timeIntegerToString.ts

@@ -1,4 +1,14 @@
-export function timeIntegerToString(timeInteger: number | undefined | null): string {
-  const timeString = ('0000' + (timeInteger ?? 0).toString()).slice(-4)
-  return timeString.slice(0, 2) + ':' + timeString.slice(2, 4)
+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.
+ */
+export function timeIntegerToString(
+  timeInteger: number | undefined | null
+): TimeString {
+  const timeString = `0000${(timeInteger ?? 0).toString()}`.slice(-4)
+
+  return `${timeString.slice(0, 2)}:${timeString.slice(2, 4)}` as TimeString
 }

package/timeStringToInteger.d.ts

@@ -1 +1,2 @@
-export declare function timeStringToInteger(timeString: string): number;
+import type { TimeString } from './dateTimeTypes.js';
+export declare function timeStringToInteger(timeString: TimeString): number;

package/timeStringToInteger.js

@@ -1,3 +1,3 @@
 export function timeStringToInteger(timeString) {
-    return Number.parseInt(('0' + timeString).replaceAll(':', ''), 10);
+    return Number.parseInt(`0${timeString}`.replaceAll(':', ''), 10);
 }

package/timeStringToInteger.ts

@@ -1,3 +1,10 @@
-export function timeStringToInteger(timeString: string): number {
-  return Number.parseInt(('0' + timeString).replaceAll(':', ''), 10)
+import type { TimeString } from './dateTimeTypes.js'
+
+/**
+ * Formats a string representing a time as a number.
+ * @param {TimeString} timeString - A string representing a time.
+ * @returns {number} - A number representing a time.
+ */
+export function timeStringToInteger(timeString: TimeString): number {
+  return Number.parseInt(`0${timeString}`.replaceAll(':', ''), 10)
 }