@naturalcycles/js-lib 14.243.1 → 14.245.0

package/dist/datetime/dateInterval.d.ts

@@ -1,5 +1,5 @@
 import { Inclusiveness } from '../types';
-import { LocalDateInput, LocalDateUnit, LocalDate } from './localDate';
+import { LocalDate, LocalDateInput, LocalDateUnit } from './localDate';
 export type DateIntervalConfig = DateInterval | DateIntervalString;
 export type DateIntervalString = string;
 /**

package/dist/datetime/dateInterval.js

@@ -63,7 +63,7 @@ class DateInterval {
      */
     cmp(d) {
         d = DateInterval.parse(d);
-        return this.start.cmp(d.start) || this.end.cmp(d.end);
+        return this.start.compare(d.start) || this.end.compare(d.end);
     }
     getDays(incl = '[]') {
         return localDate_1.localDate.range(this.start, this.end, incl, 1, 'day');

package/dist/datetime/localDate.d.ts

@@ -11,19 +11,16 @@ export type LocalDateFormatter = (ld: LocalDate) => string;
  * It is timezone-independent.
  */
 export declare class LocalDate {
-    private $year;
-    private $month;
-    private $day;
-    constructor($year: number, $month: number, $day: number);
+    year: number;
+    month: number;
+    day: number;
+    constructor(year: number, month: number, day: number);
     get(unit: LocalDateUnitStrict): number;
     set(unit: LocalDateUnitStrict, v: number, mutate?: boolean): LocalDate;
-    year(): number;
-    year(v: number): LocalDate;
-    month(): number;
-    month(v: number): LocalDate;
-    day(): number;
-    day(v: number): LocalDate;
-    dayOfWeek(): ISODayOfWeek;
+    setYear(v: number): LocalDate;
+    setMonth(v: number): LocalDate;
+    setDay(v: number): LocalDate;
+    get dayOfWeek(): ISODayOfWeek;
     isSame(d: LocalDateInput): boolean;
     isBefore(d: LocalDateInput, inclusive?: boolean): boolean;
     isSameOrBefore(d: LocalDateInput): boolean;
@@ -67,7 +64,7 @@ export declare class LocalDate {
      * returns 0 if they are equal
      * returns -1 if this < d
      */
-    cmp(d: LocalDateInput): -1 | 0 | 1;
+    compare(d: LocalDateInput): -1 | 0 | 1;
     /**
      * Same as Math.abs( diff )
      */
@@ -94,7 +91,7 @@ export declare class LocalDate {
      * Returns how many days are in the current month.
      * E.g 31 for January.
      */
-    daysInMonth(): number;
+    get daysInMonth(): number;
     clone(): LocalDate;
     /**
      * Converts LocalDate into instance of Date.
@@ -140,19 +137,37 @@ export declare class LocalDate {
     /**
      * Returns unix timestamp of 00:00:00 of that date (in UTC, because unix timestamp always reflects UTC).
      */
-    unix(): UnixTimestampNumber;
+    get unix(): UnixTimestampNumber;
     /**
      * Same as .unix(), but in milliseconds.
      */
-    unixMillis(): UnixTimestampMillisNumber;
+    get unixMillis(): UnixTimestampMillisNumber;
     toJSON(): IsoDateString;
     format(fmt: Intl.DateTimeFormat | LocalDateFormatter): string;
 }
 declare class LocalDateFactory {
     /**
-     * Create LocalDate from year, month and day components.
+     * Creates a LocalDate from the input, unless it's falsy - then returns undefined.
+     *
+     * Similar to `localDate.orToday`, but that will instead return Today on falsy input.
+     */
+    orUndefined(d: LocalDateInputNullable): LocalDate | undefined;
+    /**
+     * Creates a LocalDate from the input, unless it's falsy - then returns localDate.today.
+     */
+    orToday(d: LocalDateInputNullable): LocalDate;
+    /**
+     * Creates LocalDate that represents `today` (in local timezone).
+     */
+    today(): LocalDate;
+    /**
+     * Creates LocalDate that represents `today` in UTC.
      */
-    create(year: number, month: number, day: number): LocalDate;
+    todayInUTC(): LocalDate;
+    /**
+     Convenience function to return current today's IsoDateString representation, e.g `2024-06-21`
+     */
+    todayString(): IsoDateString;
     /**
      * Create LocalDate from LocalDateInput.
      * Input can already be a LocalDate - it is returned as-is in that case.
@@ -162,42 +177,62 @@ declare class LocalDateFactory {
      *
      * Will throw if it fails to parse/construct LocalDate.
      */
-    of(d: LocalDateInput): LocalDate;
+    fromInput(input: LocalDateInput): LocalDate;
+    /**
+     * Returns true if input is valid to create LocalDate.
+     */
+    isValid(input: LocalDateInputNullable): boolean;
     /**
-     * Tries to construct LocalDate from LocalDateInput, returns null otherwise.
-     * Does not throw (returns null instead).
+     * Returns true if isoString is a valid iso8601 string like `yyyy-mm-dd`.
+     */
+    isValidString(isoString: string | undefined | null): boolean;
+    /**
+     * Tries to convert/parse the input into LocalDate.
+     * Uses LOOSE parsing.
+     * If invalid - doesn't throw, but returns undefined instead.
      */
-    parseOrNull(d: LocalDateInputNullable): LocalDate | null;
+    try(input: LocalDateInputNullable): LocalDate | undefined;
+    /**
+     * Performs STRICT parsing.
+     * Only allows IsoDateString input, nothing else.
+     */
+    fromIsoDateString(s: IsoDateString): LocalDate;
     /**
      * Parses "compact iso8601 format", e.g `19840621` into LocalDate.
      * Throws if it fails to do so.
      */
-    parseCompact(d: string): LocalDate;
-    getYearLength(year: number): number;
-    getMonthLength(year: number, month: number): number;
-    isLeapYear(year: number): boolean;
+    fromCompactString(s: string): LocalDate;
     /**
-     * Constructs LocalDate from Date.
-     * Takes Date as-is, in its timezone - local or UTC.
+     * Performs LOOSE parsing.
+     * Tries to coerce imprefect/incorrect string input into IsoDateString.
+     * Use with caution.
+     * Allows to input IsoDateTimeString, will drop the Time part of it.
      */
-    fromDate(d: Date): LocalDate;
+    parse(s: string): LocalDate;
     /**
-     * Constructs LocalDate from Date.
-     * Takes Date's year/month/day components in UTC, using getUTCFullYear, getUTCMonth, getUTCDate.
+     * Throws if it fails to parse the input string via Regex and YMD validation.
      */
-    fromDateInUTC(d: Date): LocalDate;
+    private parseToLocalDate;
     /**
-     * Returns true if isoString is a valid iso8601 string like `yyyy-mm-dd`.
+     * Tries to parse the input string, returns undefined if input is invalid.
      */
-    isValid(isoString: string | undefined | null): boolean;
+    private parseToLocalDateOrUndefined;
     /**
-     * Creates LocalDate that represents `today` (in local timezone).
+     * Throws on invalid value.
      */
-    today(): LocalDate;
+    private validateDateObject;
+    isDateObjectValid({ year, month, day }: DateObject): boolean;
     /**
-     * Creates LocalDate that represents `today` in UTC.
+     * Constructs LocalDate from Date.
+     * Takes Date as-is, in its timezone - local or UTC.
      */
-    todayInUTC(): LocalDate;
+    fromDate(d: Date): LocalDate;
+    /**
+     * Constructs LocalDate from Date.
+     * Takes Date's year/month/day components in UTC, using getUTCFullYear, getUTCMonth, getUTCDate.
+     */
+    fromDateInUTC(d: Date): LocalDate;
+    fromDateObject(o: DateObject): LocalDate;
     /**
      * Sorts an array of LocalDates in `dir` order (ascending by default).
      */
@@ -230,23 +265,12 @@ declare class LocalDateFactory {
      * By default, min is included, max is excluded.
      */
     rangeIterable(min: LocalDateInput, max: LocalDateInput, incl?: Inclusiveness, step?: number, stepUnit?: LocalDateUnit): Iterable2<LocalDate>;
-    /**
-     * Creates a LocalDate from the input, unless it's falsy - then returns undefined.
-     *
-     * Similar to `localDate.orToday`, but that will instead return Today on falsy input.
-     */
-    orUndefined(d: LocalDateInputNullable): LocalDate | undefined;
-    /**
-     * Creates a LocalDate from the input, unless it's falsy - then returns localDate.today.
-     */
-    orToday(d: LocalDateInputNullable): LocalDate;
+    getYearLength(year: number): number;
+    getMonthLength(year: number, month: number): number;
+    isLeapYear(year: number): boolean;
 }
 interface LocalDateFn extends LocalDateFactory {
     (d: LocalDateInput): LocalDate;
 }
 export declare const localDate: LocalDateFn;
-/**
- Convenience function to return current today's IsoDateString representation, e.g `2024-06-21`
- */
-export declare function todayString(): IsoDateString;
 export {};