scdate 4.1.1 → 4.3.0

package/README.md

@@ -164,6 +164,11 @@ const totalMinutes = getTimeInMinutes(time1) // Get total minutes since midnight
 
 // Time formatting
 const timeString = get12HourTimeString(time1) // e.g., "2:30 PM"
+const compactTime = getCompact12HourTimeString(time1) // e.g., "2:30pm" (or "2pm" when minutes are zero)
+const compactLabeled = getCompact12HourTimeString(time1, {
+  onMidnightText: () => 'Midnight',
+  onNoonText: () => 'Noon',
+})
 const hoursString = get12HoursHoursStringFromTime(time1) // Get hours in 12-hour format (e.g., "2")
 const minutesString = getMinutesStringFromTime(time1) // Get minutes as 2-digit string (e.g., "30")
 
@@ -186,6 +191,8 @@ const isPM = isTimePM(time1)
 
 - **`get12HoursHoursStringFromTime(time)`**: Returns the hours component in 12-hour format as a string (1-12).
 
+- **`getCompact12HourTimeString(time, options?)`**: Returns a compact 12-hour string with lowercase `am`/`pm`, no space before the period, and minutes omitted when zero (e.g. `8am`, `11:45pm`). Optional `STimeCompact12HourStringOptions` (`onMidnightText` / `onNoonText`) replace the default for exact `00:00` and `12:00` only.
+
 - **`getMinutesStringFromTime(time)`**: Returns the minutes component as a zero-padded 2-digit string (00-59).
 
 ### Timestamp Operations (`STimestamp`)

package/dist/sTime.d.ts

@@ -1,4 +1,19 @@
 import { STime } from './internal/STime.js';
+/**
+ * Options for customizing the compact 12-hour time string representation.
+ */
+export interface STimeCompact12HourStringOptions {
+    /**
+     * Called when the time is exactly midnight (00:00). Return value replaces the
+     * default `12am` text.
+     */
+    onMidnightText?: () => string;
+    /**
+     * Called when the time is exactly noon (12:00). Return value replaces the
+     * default `12pm` text.
+     */
+    onNoonText?: () => string;
+}
 /**
  * --- Factory ---
  */
@@ -67,6 +82,15 @@ export declare const getMinutesStringFromTime: (time: string | STime) => string;
  * in the HH:MM format.
  */
 export declare const get12HourTimeString: (time: string | STime) => string;
+/**
+ * Returns a compact 12-hour time string: lowercase `am`/`pm`, no space before
+ * the period, and minutes omitted when they are zero (e.g. `8am`, `11:45pm`).
+ *
+ * @param time The time to format. It can be an STime or a string in the HH:MM
+ * format.
+ * @param options Optional callbacks for exact midnight and noon.
+ */
+export declare const getCompact12HourTimeString: (time: string | STime, options?: STimeCompact12HourStringOptions) => string;
 /**
  * Returns the time converted to minutes since midnight.
  *

package/dist/sTime.js

@@ -98,6 +98,27 @@ export const get12HourTimeString = (time) => {
     const sTimeValue = sTime(time);
     return `${get12HoursHoursStringFromTime(sTimeValue)}:${getMinutesStringFromTime(sTimeValue)} ${isTimePM(sTimeValue) ? 'PM' : 'AM'}`;
 };
+/**
+ * Returns a compact 12-hour time string: lowercase `am`/`pm`, no space before
+ * the period, and minutes omitted when they are zero (e.g. `8am`, `11:45pm`).
+ *
+ * @param time The time to format. It can be an STime or a string in the HH:MM
+ * format.
+ * @param options Optional callbacks for exact midnight and noon.
+ */
+export const getCompact12HourTimeString = (time, options) => {
+    const sTimeValue = sTime(time);
+    if (sTimeValue.time === '00:00' && options?.onMidnightText) {
+        return options.onMidnightText();
+    }
+    if (sTimeValue.time === '12:00' && options?.onNoonText) {
+        return options.onNoonText();
+    }
+    const minutes = getMinutesFromTime(sTimeValue);
+    const minutesPart = minutes === 0 ? '' : `:${getMinutesStringFromTime(sTimeValue)}`;
+    const period = isTimePM(sTimeValue) ? 'pm' : 'am';
+    return `${get12HoursHoursStringFromTime(sTimeValue)}${minutesPart}${period}`;
+};
 /**
  * Returns the time converted to minutes since midnight.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "scdate",
-  "version": "4.1.1",
+  "version": "4.3.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js"