@naturalcycles/js-lib 14.183.1 → 14.184.1

package/dist/datetime/localDate.d.ts

@@ -1,4 +1,4 @@
-import type { IsoDateString, IsoDateTimeString, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
+import type { IsoDateString, IsoDateTimeString, MonthId, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
 import { LocalTime } from './localTime';
 export type LocalDateUnit = LocalDateUnitStrict | 'week';
 export type LocalDateUnitStrict = 'year' | 'month' | 'day';
@@ -49,6 +49,14 @@ export declare class LocalDate {
     isAfter(d: LocalDateInput, inclusive?: boolean): boolean;
     isSameOrAfter(d: LocalDateInput): boolean;
     isBetween(min: LocalDateInput, max: LocalDateInput, incl?: Inclusiveness): boolean;
+    /**
+     * Checks if this localDate is older than "today" by X units.
+     *
+     * Example:
+     *
+     * localDate(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n: number, unit: LocalDateUnitStrict): boolean;
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -88,6 +96,7 @@ export declare class LocalDate {
     toISODateTime(): IsoDateTimeString;
     toString(): IsoDateString;
     toStringCompact(): string;
+    toMonthId(): MonthId;
     unix(): UnixTimestampNumber;
     unixMillis(): UnixTimestampMillisNumber;
     toJSON(): IsoDateString;

package/dist/datetime/localDate.js

@@ -179,6 +179,16 @@ class LocalDate {
             return false;
         return true;
     }
+    /**
+     * Checks if this localDate is older than "today" by X units.
+     *
+     * Example:
+     *
+     * localDate(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n, unit) {
+        return this.isBefore(LocalDate.today().add(-n, unit));
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -393,6 +403,9 @@ class LocalDate {
             String(this.$day).padStart(2, '0'),
         ].join('');
     }
+    toMonthId() {
+        return this.toString().slice(0, 7);
+    }
     // May be not optimal, as LocalTime better suits it
     unix() {
         return Math.floor(this.toDate().valueOf() / 1000);

package/dist/datetime/localTime.d.ts

@@ -1,4 +1,4 @@
-import type { IsoDateString, IsoDateTimeString, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
+import type { IsoDateString, IsoDateTimeString, MonthId, UnixTimestampMillisNumber, UnixTimestampNumber } from '../types';
 import type { Inclusiveness } from './localDate';
 import { LocalDate } from './localDate';
 export type LocalTimeUnit = 'year' | 'month' | 'week' | 'day' | 'hour' | 'minute' | 'second';
@@ -87,6 +87,14 @@ export declare class LocalTime {
     isAfter(d: LocalTimeInput, inclusive?: boolean): boolean;
     isSameOrAfter(d: LocalTimeInput): boolean;
     isBetween(min: LocalTimeInput, max: LocalTimeInput, incl?: Inclusiveness): boolean;
+    /**
+     * Checks if this localTime is older than "now" by X units.
+     *
+     * Example:
+     *
+     * localTime(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n: number, unit: LocalTimeUnit): boolean;
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -120,6 +128,7 @@ export declare class LocalTime {
     toStringCompact(seconds?: boolean): string;
     toString(): string;
     toJSON(): UnixTimestampNumber;
+    toMonthId(): MonthId;
     format(fmt: Intl.DateTimeFormat | LocalTimeFormatter): string;
 }
 /**

package/dist/datetime/localTime.js

@@ -357,6 +357,16 @@ class LocalTime {
             return false;
         return true;
     }
+    /**
+     * Checks if this localTime is older than "now" by X units.
+     *
+     * Example:
+     *
+     * localTime(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n, unit) {
+        return this.isBefore(LocalTime.now().add(-n, unit));
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -480,6 +490,9 @@ class LocalTime {
     toJSON() {
         return this.unix();
     }
+    toMonthId() {
+        return this.$date.toISOString().slice(0, 7);
+    }
     format(fmt) {
         if (fmt instanceof Intl.DateTimeFormat) {
             return fmt.format(this.$date);

package/dist/types.d.ts

@@ -153,6 +153,13 @@ export type IsoDateString = string;
  * @example '2019-06-21T05:21:73Z'
  */
 export type IsoDateTimeString = string;
+/**
+ * Identifies the Month.
+ * Like IsoDateString, but without the Day token.
+ *
+ * @example '2023-09'
+ */
+export type MonthId = string;
 /**
  * Interface explicitly states that the value is a Unix timestamp (in seconds).
  *

package/dist-esm/datetime/localDate.js

@@ -176,6 +176,16 @@ export class LocalDate {
             return false;
         return true;
     }
+    /**
+     * Checks if this localDate is older than "today" by X units.
+     *
+     * Example:
+     *
+     * localDate(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n, unit) {
+        return this.isBefore(LocalDate.today().add(-n, unit));
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -390,6 +400,9 @@ export class LocalDate {
             String(this.$day).padStart(2, '0'),
         ].join('');
     }
+    toMonthId() {
+        return this.toString().slice(0, 7);
+    }
     // May be not optimal, as LocalTime better suits it
     unix() {
         return Math.floor(this.toDate().valueOf() / 1000);

package/dist-esm/datetime/localTime.js

@@ -355,6 +355,16 @@ export class LocalTime {
             return false;
         return true;
     }
+    /**
+     * Checks if this localTime is older than "now" by X units.
+     *
+     * Example:
+     *
+     * localTime(expirationDate).isOlderThan(5, 'day')
+     */
+    isOlderThan(n, unit) {
+        return this.isBefore(LocalTime.now().add(-n, unit));
+    }
     /**
      * Returns 1 if this > d
      * returns 0 if they are equal
@@ -478,6 +488,9 @@ export class LocalTime {
     toJSON() {
         return this.unix();
     }
+    toMonthId() {
+        return this.$date.toISOString().slice(0, 7);
+    }
     format(fmt) {
         if (fmt instanceof Intl.DateTimeFormat) {
             return fmt.format(this.$date);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/js-lib",
-  "version": "14.183.1",
+  "version": "14.184.1",
   "scripts": {
     "prepare": "husky install",
     "build-prod": "build-prod-esm-cjs",

package/src/datetime/localDate.ts

@@ -2,6 +2,7 @@ import { _assert } from '../error/assert'
 import type {
   IsoDateString,
   IsoDateTimeString,
+  MonthId,
   UnixTimestampMillisNumber,
   UnixTimestampNumber,
 } from '../types'
@@ -239,6 +240,17 @@ export class LocalDate {
     return true
   }
 
+  /**
+   * Checks if this localDate is older than "today" by X units.
+   *
+   * Example:
+   *
+   * localDate(expirationDate).isOlderThan(5, 'day')
+   */
+  isOlderThan(n: number, unit: LocalDateUnitStrict): boolean {
+    return this.isBefore(LocalDate.today().add(-n, unit))
+  }
+
   /**
    * Returns 1 if this > d
    * returns 0 if they are equal
@@ -482,6 +494,10 @@ export class LocalDate {
     ].join('')
   }
 
+  toMonthId(): MonthId {
+    return this.toString().slice(0, 7)
+  }
+
   // May be not optimal, as LocalTime better suits it
   unix(): UnixTimestampNumber {
     return Math.floor(this.toDate().valueOf() / 1000)

package/src/datetime/localTime.ts

@@ -3,6 +3,7 @@ import { _ms } from '../time/time.util'
 import type {
   IsoDateString,
   IsoDateTimeString,
+  MonthId,
   UnixTimestampMillisNumber,
   UnixTimestampNumber,
 } from '../types'
@@ -439,6 +440,17 @@ export class LocalTime {
     return true
   }
 
+  /**
+   * Checks if this localTime is older than "now" by X units.
+   *
+   * Example:
+   *
+   * localTime(expirationDate).isOlderThan(5, 'day')
+   */
+  isOlderThan(n: number, unit: LocalTimeUnit): boolean {
+    return this.isBefore(LocalTime.now().add(-n, unit))
+  }
+
   /**
    * Returns 1 if this > d
    * returns 0 if they are equal
@@ -587,6 +599,10 @@ export class LocalTime {
     return this.unix()
   }
 
+  toMonthId(): MonthId {
+    return this.$date.toISOString().slice(0, 7)
+  }
+
   format(fmt: Intl.DateTimeFormat | LocalTimeFormatter): string {
     if (fmt instanceof Intl.DateTimeFormat) {
       return fmt.format(this.$date)

package/src/types.ts

@@ -214,6 +214,14 @@ export type IsoDateString = string
  */
 export type IsoDateTimeString = string
 
+/**
+ * Identifies the Month.
+ * Like IsoDateString, but without the Day token.
+ *
+ * @example '2023-09'
+ */
+export type MonthId = string
+
 /**
  * Interface explicitly states that the value is a Unix timestamp (in seconds).
  *