@naturalcycles/js-lib 15.47.2 → 15.48.0

package/dist/datetime/localDate.d.ts

@@ -1,5 +1,5 @@
 import { Iterable2 } from '../iter/iterable2.js';
-import type { Inclusiveness, IsoDate, IsoDateTime, MonthId, MutateOptions, SortOptions, UnixTimestamp, UnixTimestampMillis } from '../types.js';
+import type { Inclusiveness, IsoDate, IsoDateTime, IsoMonth, MonthId, MutateOptions, SortOptions, UnixTimestamp, UnixTimestampMillis } from '../types.js';
 import type { DateObject, ISODayOfWeek, LocalTime } from './localTime.js';
 export type LocalDateUnit = LocalDateUnitStrict | 'week';
 export type LocalDateUnitStrict = 'year' | 'month' | 'day';
@@ -132,6 +132,10 @@ export declare class LocalDate {
      * Returns e.g: `1984-06-21`
      */
     toISODate(): IsoDate;
+    /**
+     * Returns e.g: `1984-06`
+     */
+    toISOMonth(): IsoMonth;
     /**
      * Returns e.g: `1984-06-21T00:00:00`
      * Hours, minutes and seconds are 0.
@@ -148,7 +152,7 @@ export declare class LocalDate {
      */
     toStringCompact(): string;
     /**
-     * Returns e.g: `1984-06`
+     * @deprecated Use toIsoMonth
      */
     toMonthId(): MonthId;
     /**

package/dist/datetime/localDate.js

@@ -401,6 +401,12 @@ export class LocalDate {
             String(this.day).padStart(2, '0'),
         ].join('-');
     }
+    /**
+     * Returns e.g: `1984-06`
+     */
+    toISOMonth() {
+        return this.toISODate().slice(0, 7);
+    }
     /**
      * Returns e.g: `1984-06-21T00:00:00`
      * Hours, minutes and seconds are 0.
@@ -429,10 +435,10 @@ export class LocalDate {
         ].join('');
     }
     /**
-     * Returns e.g: `1984-06`
+     * @deprecated Use toIsoMonth
      */
     toMonthId() {
-        return this.toISODate().slice(0, 7);
+        return this.toISOMonth();
     }
     /**
      * Returns unix timestamp of 00:00:00 of that date (in UTC, because unix timestamp always reflects UTC).

package/dist/datetime/localTime.d.ts

@@ -1,4 +1,4 @@
-import type { IANATimezone, Inclusiveness, IsoDate, IsoDateTime, MonthId, MutateOptions, NumberOfHours, NumberOfMinutes, SortDirection, UnixTimestamp, UnixTimestampMillis } from '../types.js';
+import type { IANATimezone, Inclusiveness, IsoDate, IsoDateTime, IsoMonth, MonthId, MutateOptions, NumberOfHours, NumberOfMinutes, SortDirection, UnixTimestamp, UnixTimestampMillis } from '../types.js';
 import type { LocalDate } from './localDate.js';
 import { WallTime } from './wallTime.js';
 export type LocalTimeUnit = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';
@@ -216,6 +216,10 @@ export declare class LocalTime {
      * Returns e.g: `1984-06-21`, only the date part of DateTime
      */
     toISODate(): IsoDate;
+    /**
+     * Returns e.g: `1984-06`
+     */
+    toISOMonth(): IsoMonth;
     /**
      * Returns e.g: `17:03:15` (or `17:03` with seconds=false)
      */
@@ -227,6 +231,9 @@ export declare class LocalTime {
     toStringCompact(seconds?: boolean): string;
     toString(): IsoDateTime;
     toJSON(): UnixTimestamp;
+    /**
+     * @deprecated Use toIsoMonth
+     */
     toMonthId(): MonthId;
     format(fmt: Intl.DateTimeFormat | LocalTimeFormatter): string;
 }

package/dist/datetime/localTime.js

@@ -589,6 +589,12 @@ export class LocalTime {
         // !! Not using toISOString(), as it returns time in UTC, not in local timezone (unexpected!)
         // return this.$date.toISOString().slice(0, 10)
     }
+    /**
+     * Returns e.g: `1984-06`
+     */
+    toISOMonth() {
+        return this.toISODate().slice(0, 7);
+    }
     /**
      * Returns e.g: `17:03:15` (or `17:03` with seconds=false)
      */
@@ -628,8 +634,11 @@ export class LocalTime {
     toJSON() {
         return this.unix;
     }
+    /**
+     * @deprecated Use toIsoMonth
+     */
     toMonthId() {
-        return this.toISODate().slice(0, 7);
+        return this.toISOMonth();
     }
     format(fmt) {
         if (fmt instanceof Intl.DateTimeFormat) {

package/dist/types.d.ts

@@ -191,10 +191,15 @@ export type IsoDate = Branded<string, 'IsoDate'>;
  */
 export type IsoDateTime = Branded<string, 'IsoDateTime'>;
 /**
- * Identifies the Month.
- * Like IsoDate, but without the Day token.
+ * ISO 8601 month (YYYY-MM).
+ * Branded type.
  *
- * @example '2023-09'
+ * @example '2019-06'
+ */
+export type IsoMonth = Branded<string, 'IsoMonth'>;
+/**
+ * Identifies the Month.
+ * @deprecated Use IsoMonth
  */
 export type MonthId = string;
 /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@naturalcycles/js-lib",
   "type": "module",
-  "version": "15.47.2",
+  "version": "15.48.0",
   "dependencies": {
     "tslib": "^2",
     "undici": "^7",
@@ -54,7 +54,7 @@
   "types": "dist/index.d.ts",
   "sideEffects": false,
   "engines": {
-    "node": ">=24.10.0"
+    "node": ">=24.11.0"
   },
   "publishConfig": {
     "provenance": true,

package/src/datetime/localDate.ts

@@ -4,6 +4,7 @@ import type {
   Inclusiveness,
   IsoDate,
   IsoDateTime,
+  IsoMonth,
   MonthId,
   MutateOptions,
   SortOptions,
@@ -474,6 +475,13 @@ export class LocalDate {
     ].join('-') as IsoDate
   }
 
+  /**
+   * Returns e.g: `1984-06`
+   */
+  toISOMonth(): IsoMonth {
+    return this.toISODate().slice(0, 7) as IsoMonth
+  }
+
   /**
    * Returns e.g: `1984-06-21T00:00:00`
    * Hours, minutes and seconds are 0.
@@ -506,10 +514,10 @@ export class LocalDate {
   }
 
   /**
-   * Returns e.g: `1984-06`
+   * @deprecated Use toIsoMonth
    */
   toMonthId(): MonthId {
-    return this.toISODate().slice(0, 7)
+    return this.toISOMonth()
   }
 
   /**

package/src/datetime/localTime.ts

@@ -4,6 +4,7 @@ import type {
   Inclusiveness,
   IsoDate,
   IsoDateTime,
+  IsoMonth,
   MonthId,
   MutateOptions,
   NumberOfHours,
@@ -710,6 +711,13 @@ export class LocalTime {
     // return this.$date.toISOString().slice(0, 10)
   }
 
+  /**
+   * Returns e.g: `1984-06`
+   */
+  toISOMonth(): IsoMonth {
+    return this.toISODate().slice(0, 7) as IsoMonth
+  }
+
   /**
    * Returns e.g: `17:03:15` (or `17:03` with seconds=false)
    */
@@ -757,8 +765,11 @@ export class LocalTime {
     return this.unix
   }
 
+  /**
+   * @deprecated Use toIsoMonth
+   */
   toMonthId(): MonthId {
-    return this.toISODate().slice(0, 7)
+    return this.toISOMonth()
   }
 
   format(fmt: Intl.DateTimeFormat | LocalTimeFormatter): string {

package/src/types.ts

@@ -247,10 +247,16 @@ export type IsoDate = Branded<string, 'IsoDate'>
 export type IsoDateTime = Branded<string, 'IsoDateTime'>
 
 /**
- * Identifies the Month.
- * Like IsoDate, but without the Day token.
+ * ISO 8601 month (YYYY-MM).
+ * Branded type.
  *
- * @example '2023-09'
+ * @example '2019-06'
+ */
+export type IsoMonth = Branded<string, 'IsoMonth'>
+
+/**
+ * Identifies the Month.
+ * @deprecated Use IsoMonth
  */
 export type MonthId = string