@dereekb/util 13.11.2 → 13.11.4

package/src/lib/date/date.d.ts

@@ -33,11 +33,22 @@ export type ISO8601DateString = string;
  * Regular expression for validating ISO8601 date strings.
  *
  * TODO(FUTURE): Need to improve to support negative years.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, iso8601, regex, string, validate
+ * @dbxUtilRelated is-iso8601-date-string, iso8601-day-string-regex
  */
 export declare const ISO_8601_DATE_STRING_REGEX: RegExp;
 /**
  * Determines if a string is a valid ISO8601 date string.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, iso8601, string, predicate, validate
+ * @dbxUtilRelated is-iso8601-day-string, is-utc-date-string, iso-8601-date-string-regex
+ *
  * @param input - The string to test
  * @returns True if the input is a valid ISO8601 date string
  */
@@ -58,11 +69,22 @@ export type UTCDateString = string;
  * Sat, 03 Feb 2001 04:05:06 GMT
  * Tue, 14 Mar 2023 12:34:56 UTC
  * Wed, 25 May 2024 20:45:07 EST
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, utc, regex, string, validate
+ * @dbxUtilRelated is-utc-date-string
  */
 export declare const UTC_DATE_STRING_REGEX: RegExp;
 /**
  * Determines if a string is a valid UTC date string.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, utc, string, predicate, validate
+ * @dbxUtilRelated is-iso8601-date-string, utc-date-string-regex
+ *
  * @param input - The string to test
  * @returns True if the input is a valid UTC date string
  */
@@ -104,6 +126,11 @@ export interface TimezoneStringRef {
 /**
  * Returns true only if the inputs have the same timezone, or both do not have a timezone set.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, timezone, compare, equal, predicate
+ * @dbxUtilRelated is-considered-utc-timezone-string
+ *
  * @param a - First object that may contain a timezone reference
  * @param b - Second object that may contain a timezone reference
  * @returns True if both objects have the same timezone or neither has a timezone set
@@ -111,6 +138,12 @@ export interface TimezoneStringRef {
 export declare function hasSameTimezone(a: Maybe<Partial<TimezoneStringRef>>, b: Maybe<Partial<TimezoneStringRef>>): boolean;
 /**
  * Constant for the UTC timezone string, "UTC".
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, timezone, utc, string, constant
+ * @dbxUtilRelated is-considered-utc-timezone-string
  */
 export declare const UTC_TIMEZONE_STRING = "UTC";
 /**
@@ -121,6 +154,11 @@ export type UTCTimezoneAbbreviation = typeof UTC_TIMEZONE_STRING;
  * Determines whether the input timezone string is considered UTC.
  * Returns true for null, undefined, or the string 'UTC'.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, timezone, utc, predicate
+ * @dbxUtilRelated has-same-timezone, utc-timezone-string
+ *
  * @param timezone - The timezone string to check
  * @returns True if the timezone is considered UTC
  */
@@ -153,10 +191,22 @@ export type ISO8601DayString = string;
 export type DateOrDayString = Date | ISO8601DayString;
 /**
  * Regex for an ISO8601DayString.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, iso8601, day, regex, string, validate
+ * @dbxUtilRelated is-iso8601-day-string, iso8601-day-string-start-regex
  */
 export declare const ISO8601_DAY_STRING_REGEX: RegExp;
 /**
  * Regex for a string that starts as an ISO8601DayString.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, iso8601, day, regex, prefix
+ * @dbxUtilRelated is-iso8601-day-string-start, iso8601-day-string-regex
  */
 export declare const ISO8601_DAY_STRING_START_REGEX: RegExp;
 /**
@@ -164,6 +214,11 @@ export declare const ISO8601_DAY_STRING_START_REGEX: RegExp;
  *
  * I.E. 2022-01-02T04:00:00.000Z in GMT-6 returns 2022-01-02
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, utc, start-of-day, day, normalize
+ * @dbxUtilRelated start-of-day-for-system-date-in-utc, parse-iso8601-day-string-to-utc-date
+ *
  * @param date - The date to get the start of day for
  * @returns A new Date set to midnight UTC of the input date's UTC day
  */
@@ -173,6 +228,11 @@ export declare function startOfDayForUTCDateInUTC(date: Date): Date;
  *
  * I.E. 2022-01-02T04:00:00.000Z in GMT-6 (10PM Jan 1st CST) returns 2022-01-01
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, utc, start-of-day, system, local
+ * @dbxUtilRelated start-of-day-for-utc-date-in-utc
+ *
  * @param date - The date to get the start of local day for
  * @returns A new Date set to midnight UTC of the input date's local day
  */
@@ -180,6 +240,11 @@ export declare function startOfDayForSystemDateInUTC(date: Date): Date;
 /**
  * Parses an ISO8601DayString (YYYY-MM-DD) to a UTC Date at midnight.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, iso8601, day, parse, utc, convert
+ * @dbxUtilRelated is-iso8601-day-string, start-of-day-for-utc-date-in-utc
+ *
  * @param inputDateString - The ISO8601 day string to parse (e.g., '2022-01-15')
  * @returns A Date object set to midnight UTC on the specified day
  */
@@ -187,6 +252,11 @@ export declare function parseISO8601DayStringToUTCDate(inputDateString: ISO8601D
 /**
  * Determines if a string is a valid ISO8601 day string (YYYY-MM-DD format).
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, iso8601, day, string, predicate, validate
+ * @dbxUtilRelated is-iso8601-day-string-start, parse-iso8601-day-string-to-utc-date, iso8601-day-string-regex
+ *
  * @param input - The string to test
  * @returns True if the input is a valid ISO8601 day string
  */
@@ -194,6 +264,11 @@ export declare function isISO8601DayString(input: string): input is ISO8601DaySt
 /**
  * Determines if a string starts with a valid ISO8601 day string pattern (YYYY-MM-DD).
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, iso8601, day, string, predicate, prefix
+ * @dbxUtilRelated is-iso8601-day-string, iso8601-day-string-start-regex
+ *
  * @param input - The string to test
  * @returns True if the input starts with a valid ISO8601 day string pattern
  */
@@ -208,11 +283,22 @@ export declare function isISO8601DayStringStart(input: string): input is ISO8601
 export type MonthDaySlashDate = string;
 /**
  * Regex for a MonthDaySlashDate.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, slash, month, day, regex, string, validate
+ * @dbxUtilRelated is-month-day-slash-date
  */
 export declare const MONTH_DAY_SLASH_DATE_STRING_REGEX: RegExp;
 /**
  * Determines if a string is a valid Month/Day/Year slash date format.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, slash, month, day, string, predicate, validate
+ * @dbxUtilRelated month-day-slash-date-to-date-string, month-day-slash-date-string-regex
+ *
  * @param input - The string to test
  * @returns True if the input is a valid Month/Day/Year slash date
  */
@@ -222,6 +308,11 @@ export declare function isMonthDaySlashDate(input: string): input is MonthDaySla
  * Handles single digit months and days by adding leading zeros.
  * If year is only 2 digits, prepends '20' to make a 4-digit year.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, slash, day, string, convert, parse
+ * @dbxUtilRelated is-month-day-slash-date
+ *
  * @param slashDate - The slash date string to convert (e.g., '1/1/20' or '11/15/2022')
  * @returns An ISO8601 formatted day string (YYYY-MM-DD)
  */
@@ -243,6 +334,11 @@ export type DateOrUnixDateTimeMillisecondsNumber = Date | UnixDateTimeMillisecon
 /**
  * Converts a Date object or unix timestamp (in milliseconds) to a Date object.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, milliseconds, unix, convert, normalize
+ * @dbxUtilRelated unix-milliseconds-number-to-date, date-or-milliseconds-to-date
+ *
  * @param input - Date object or unix timestamp (in milliseconds) to convert
  * @returns Date object if input is valid. Returns null/undefined if input is null/undefined
  */
@@ -252,6 +348,11 @@ export declare function dateFromDateOrTimeMillisecondsNumber(input: Maybe<DateOr
 /**
  * Converts a unix timestamp number to a Date object.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, milliseconds, unix, convert, parse
+ * @dbxUtilRelated date-from-date-or-time-milliseconds-number, unix-date-time-seconds-number-to-date
+ *
  * @param dateTimeNumber - Unix timestamp number to convert
  * @returns Date object if timestamp is valid, null/undefined if timestamp is null/undefined
  */
@@ -276,6 +377,11 @@ export type DateOrMilliseconds = Date | Milliseconds;
  *
  * If the input is a number of milliseconds, it is added to the current date.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, milliseconds, convert, normalize, offset
+ * @dbxUtilRelated add-milliseconds, date-from-date-or-time-milliseconds-number
+ *
  * @param dateOrMilliseconds - The date or milliseconds to convert to a Date.
  * @param now - The current date to use when adding milliseconds. Defaults to the current time.
  * @returns The Date representation of the input.
@@ -319,50 +425,132 @@ export type Hours = number;
 export type Days = number;
 /**
  * Number of days in a year (ignoring leap years, which are 366 days).
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, day, year, duration, constant
+ * @dbxUtilRelated days-in-week
  */
 export declare const DAYS_IN_YEAR: Days;
 /**
  * Number of hours in a day.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, hour, day, duration, constant
+ * @dbxUtilRelated minutes-in-day, ms-in-day
  */
 export declare const HOURS_IN_DAY: Hours;
 /**
  * Number of seconds in a minute.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, second, minute, duration, constant
+ * @dbxUtilRelated seconds-in-hour, ms-in-second
  */
 export declare const SECONDS_IN_MINUTE: Seconds;
 /**
  * Number of minutes in a day.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, minute, day, duration, constant
+ * @dbxUtilRelated hours-in-day, minutes-in-hour
  */
 export declare const MINUTES_IN_DAY: Minutes;
 /**
  * Number of minutes in an hour.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, minute, hour, duration, constant
+ * @dbxUtilRelated minutes-in-day, seconds-in-minute
  */
 export declare const MINUTES_IN_HOUR: Minutes;
 /**
  * Number of seconds in an hour.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, second, hour, duration, constant
+ * @dbxUtilRelated seconds-in-minute, minutes-in-hour
  */
 export declare const SECONDS_IN_HOUR: Minutes;
 /**
  * Number of milliseconds in a second.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, milliseconds, second, duration, constant
+ * @dbxUtilRelated ms-in-minute, seconds-in-minute
  */
 export declare const MS_IN_SECOND: Milliseconds;
 /**
  * Number of milliseconds in a minute.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, milliseconds, minute, duration, constant
+ * @dbxUtilRelated ms-in-second, ms-in-hour
  */
 export declare const MS_IN_MINUTE: Milliseconds;
 /**
  * Number of milliseconds in an hour.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, milliseconds, hour, duration, constant
+ * @dbxUtilRelated ms-in-minute, ms-in-day
  */
 export declare const MS_IN_HOUR: Milliseconds;
 /**
  * Number of milliseconds in a day.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, milliseconds, day, duration, constant
+ * @dbxUtilRelated ms-in-hour, ms-in-week, hours-in-day
  */
 export declare const MS_IN_DAY: Milliseconds;
+/**
+ * Number of seconds in a day.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, seconds, day, duration, constant
+ * @dbxUtilRelated seconds-in-hour, seconds-in-week
+ */
+export declare const SECONDS_IN_DAY: Seconds;
 /**
  * Number of days in a week.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, day, week, duration, constant
+ * @dbxUtilRelated ms-in-week, days-in-year
  */
 export declare const DAYS_IN_WEEK: Days;
 /**
  * Number of milliseconds in a week.
+ *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind const
+ * @dbxUtilTags date, milliseconds, week, duration, constant
+ * @dbxUtilRelated ms-in-day, days-in-week
  */
 export declare const MS_IN_WEEK: Milliseconds;
 /**
@@ -396,6 +584,11 @@ export type DateMonth = number;
  *
  * Converts JavaScript's 0-based month (0-11) to a 1-based month (1-12).
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, month, year, accessor, system, local
+ * @dbxUtilRelated month-of-year-from-date-month, month-of-year-from-utc-date
+ *
  * @param date - The date to extract the month from
  * @returns The month of year as a number from 1-12
  */
@@ -405,6 +598,11 @@ export declare function monthOfYearFromDate(date: Date): MonthOfYear;
  *
  * Converts JavaScript's 0-based month (0-11) to a 1-based month (1-12).
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, month, year, accessor, utc
+ * @dbxUtilRelated month-of-year-from-date, month-of-year-from-date-month
+ *
  * @param date - The date to extract the month from
  * @returns The month of year as a number from 1-12
  */
@@ -412,6 +610,11 @@ export declare function monthOfYearFromUTCDate(date: Date): MonthOfYear;
 /**
  * Converts a JavaScript Date month (0-11) to a MonthOfYear (1-12).
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, month, year, convert, javascript
+ * @dbxUtilRelated make-date-month-for-month-of-year, month-of-year-from-date
+ *
  * @param dateMonth - JavaScript Date month (0-11)
  * @returns The month of year as a number from 1-12
  */
@@ -419,8 +622,14 @@ export declare function monthOfYearFromDateMonth(dateMonth: DateMonth): MonthOfY
 /**
  * Converts a MonthOfYear (1-12) to a JavaScript Date month (0-11).
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, month, convert, javascript
+ * @dbxUtilRelated month-of-year-from-date-month, month-of-year-from-date
+ *
  * @param monthOfYear - Month of year (1-12)
  * @returns JavaScript Date month (0-11)
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function makeDateMonthForMonthOfYear(monthOfYear: MonthOfYear): DateMonth;
 /**
@@ -439,6 +648,11 @@ export type DateRelativeState = DateRelativeDirection | 'present';
  * Returns true if the value is a Date object.
  * Uses both instanceof and Object.prototype.toString for reliable type checking.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, predicate, type-guard, validate
+ * @dbxUtilRelated is-equal-date, is-past
+ *
  * @param value - The value to check
  * @returns True if the value is a Date object
  */
@@ -447,6 +661,11 @@ export declare function isDate(value: unknown): value is Date;
  * Returns true if the two input dates represent the same point in time.
  * Compares the timestamp values rather than the object references.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, equal, compare, predicate
+ * @dbxUtilRelated is-date, is-past
+ *
  * @param a - First date to compare
  * @param b - Second date to compare
  * @returns True if the dates represent the same point in time
@@ -455,6 +674,11 @@ export declare function isEqualDate(a: Date, b: Date): boolean;
 /**
  * Returns true if the input date is in the past relative to the current time.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, past, compare, predicate, time
+ * @dbxUtilRelated is-equal-date, is-date
+ *
  * @param input - The date to check
  * @returns True if the date is in the past
  */
@@ -463,6 +687,11 @@ export declare function isPast(input: Date): boolean;
  * Adds milliseconds to the input date, returning a new Date object.
  * If no date is input, then returns the input unchanged.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilTags date, milliseconds, add, offset, time
+ * @dbxUtilRelated date-or-milliseconds-to-date, ms-in-second
+ *
  * @param input - The date to add milliseconds to
  * @param ms - The number of milliseconds to add (defaults to 0 if null or undefined)
  * @returns A new Date with the added milliseconds, or the original input if not a Date

package/src/lib/date/time.d.ts

@@ -104,9 +104,16 @@ export declare class TimerCancelledError extends BaseError {
 /**
  * Creates a new Timer from the input duration.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind factory
+ * @dbxUtilTags date, time, timer, factory, duration
+ * @dbxUtilRelated timer
+ *
  * @param duration - The duration of the timer.
  * @param startImmediately - Whether the timer should start immediately. Defaults to true.
  * @returns The new Timer.
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function makeTimer(duration: Milliseconds, startImmediately?: boolean): Timer;
 /**

package/src/lib/date/week.d.ts

@@ -118,8 +118,15 @@ export type DayOfWeekNameFunction = (dayOfWeek: DayOfWeek) => string;
 /**
  * Creates a function that returns the name for a given DayOfWeek.
  *
+ * @dbxUtil
+ * @dbxUtilCategory date
+ * @dbxUtilKind factory
+ * @dbxUtilTags date, week, day-of-week, name, factory, format
+ * @dbxUtilRelated days-of-week-name-map
+ *
  * @param transform - Optional configuration for abbreviation and casing
  * @returns A function that maps DayOfWeek values to name strings
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function daysOfWeekNameFunction(transform?: DayOfWeekNamesTransformConfig): DayOfWeekNameFunction;
 /**

package/src/lib/error/error.d.ts

@@ -90,8 +90,15 @@ export type ErrorMessageContainsStringFunction = (input: Maybe<ErrorInput | stri
 /**
  * Creates a function that checks if an error's message contains the target string.
  *
+ * @dbxUtil
+ * @dbxUtilCategory error
+ * @dbxUtilKind factory
+ * @dbxUtilTags error, message, contains, factory, predicate, regex
+ * @dbxUtilRelated escape-string-for-regex
+ *
  * @param target - The string to search for
  * @returns A function that checks error messages for the target string
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function errorMessageContainsStringFunction(target: string): ErrorMessageContainsStringFunction;
 /**

package/src/lib/filter/filter.d.ts

@@ -18,8 +18,15 @@ export type FilterFunction<T = unknown> = (value: T, index: number) => boolean;
  * The merged function returns true only if all individual filters pass (AND logic).
  * Null/undefined filters are ignored.
  *
+ * @dbxUtil
+ * @dbxUtilCategory value
+ * @dbxUtilKind factory
+ * @dbxUtilTags filter, merge, compose, factory, and
+ * @dbxUtilRelated invert-filter, invert-boolean-return-function
+ *
  * @param inputFilters - The filter functions to merge
  * @returns A single FilterFunction that applies all filters
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function mergeFilterFunctions<T>(...inputFilters: Maybe<FilterFunction<T>>[]): FilterFunction<T>;
 /**

package/src/lib/function/function.boolean.d.ts

@@ -5,8 +5,15 @@ export type BooleanReturnFunction = (...args: any[]) => boolean;
 /**
  * Inverts the output of an arbitrary boolean-returning function.
  *
+ * @dbxUtil
+ * @dbxUtilCategory function
+ * @dbxUtilKind factory
+ * @dbxUtilTags function, boolean, invert, predicate, factory
+ * @dbxUtilRelated decision-function, filter-function
+ *
  * @param decisionFn - The function whose boolean return value to invert
  * @param invert - Whether to apply the inversion (defaults to true)
  * @returns The inverted function, or the original if invert is false
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function invertBooleanReturnFunction<F extends BooleanReturnFunction>(decisionFn: F, invert?: boolean): F;

package/src/lib/function/function.forward.d.ts

@@ -10,8 +10,15 @@ export type ForwardFunction<I extends (...args: any[]) => O, O = unknown> = I;
  *
  * Useful for late-binding or circular dependency resolution.
  *
+ * @dbxUtil
+ * @dbxUtilCategory function
+ * @dbxUtilKind factory
+ * @dbxUtilTags function, forward, late-binding, factory, lazy
+ * @dbxUtilRelated default-forward-function-factory
+ *
  * @param getter - A Getter that provides the target function
  * @returns A forwarding function with the same signature as the target
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function forwardFunction<I extends (...args: any[]) => O, O = unknown>(getter: Getter<I>): ForwardFunction<I>;
 /**
@@ -22,7 +29,14 @@ export type DefaultForwardFunctionFactory<I extends (...args: any[]) => O, O = u
  * Creates a factory that produces forwarding functions which use the provided function
  * or fall back to the default function when not provided.
  *
+ * @dbxUtil
+ * @dbxUtilCategory function
+ * @dbxUtilKind factory
+ * @dbxUtilTags function, forward, factory, default, fallback
+ * @dbxUtilRelated forward-function
+ *
  * @param defaultFn - The default function to use as fallback
  * @returns A factory that wraps optional functions with a default fallback
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function defaultForwardFunctionFactory<I extends (...args: any[]) => O, O = unknown>(defaultFn: I): DefaultForwardFunctionFactory<I, O>;

package/src/lib/getter/getter.cache.d.ts

@@ -39,8 +39,15 @@ export type CachedFactoryWithInput<T, A = unknown> = CachedGetter<T> & FactoryWi
  * The value is retrieved once on first call and cached permanently.
  * Use `reset()` to clear the cache and `init()` to reload.
  *
+ * @dbxUtil
+ * @dbxUtilCategory getter
+ * @dbxUtilKind factory
+ * @dbxUtilTags getter, cache, memoize, lazy, factory
+ * @dbxUtilRelated as-getter, make-getter
+ *
  * @param getter - the factory or getter function whose result will be cached
  * @returns A CachedFactoryWithInput that caches the first result
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function cachedGetter<T>(getter: Getter<T>): CachedFactoryWithInput<T>;
 export declare function cachedGetter<T, A = unknown>(factory: FactoryWithInput<T, A>): CachedFactoryWithInput<T, A>;

package/src/lib/getter/getter.d.ts

@@ -100,22 +100,37 @@ export type ObjectCopyFactory<T> = Factory<T>;
  * @param value - The object to copy
  * @param copyFunction - Optional custom copy function (defaults to copyObject)
  * @returns A factory that produces copies of the value
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function objectCopyFactory<T extends object>(value: T, copyFunction?: CopyObjectFunction<T>): ObjectCopyFactory<T>;
 /**
  * Converts the input to an ObjectCopyFactory. If the input is an object, wraps it with objectCopyFactory.
  * If it's already a function (Getter), it's returned directly.
  *
+ * @dbxUtil
+ * @dbxUtilCategory getter
+ * @dbxUtilKind factory
+ * @dbxUtilTags getter, factory, copy, clone, object, normalize
+ * @dbxUtilRelated object-copy-factory, as-getter
+ *
  * @param input - An object value or a getter function
  * @param copyFunction - Optional custom copy function
  * @returns An ObjectCopyFactory for the input
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function asObjectCopyFactory<T>(input: T | ObjectCopyFactory<T>, copyFunction?: CopyObjectFunction<T>): ObjectCopyFactory<T>;
 /**
  * Wraps the input value in a Getter function that always returns it.
  *
+ * @dbxUtil
+ * @dbxUtilCategory getter
+ * @dbxUtilKind factory
+ * @dbxUtilTags getter, factory, wrap, constant
+ * @dbxUtilRelated as-getter, get-value-from-getter
+ *
  * @param input - The value to wrap
  * @returns A Getter that returns the input value
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function makeGetter<T>(input: T): Getter<T>;
 /**
@@ -125,17 +140,29 @@ export type FactoryWithIndex<T> = FactoryWithInput<T, number> | FactoryWithRequi
 /**
  * Calls a factory function the specified number of times and returns the results as an array.
  *
+ * @dbxUtil
+ * @dbxUtilCategory getter
+ * @dbxUtilTags getter, factory, generate, array, count
+ * @dbxUtilRelated make-with-factory-input, array-factory
+ *
  * @param factory - The factory function to call (receives the current index as argument)
  * @param count - The number of items to create
  * @returns An array of produced values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function makeWithFactory<T>(factory: Factory<T> | FactoryWithIndex<T>, count: number): T[];
 /**
  * Maps an array of inputs through a factory function to produce an array of outputs.
  *
+ * @dbxUtil
+ * @dbxUtilCategory getter
+ * @dbxUtilTags getter, factory, map, array, transform
+ * @dbxUtilRelated make-with-factory
+ *
  * @param factory - The factory function to call with each input
  * @param input - The array of inputs to pass to the factory
  * @returns An array of produced values
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function makeWithFactoryInput<T, A>(factory: FactoryWithInput<T, A>, input: Maybe<A>[]): T[];
 export declare function makeWithFactoryInput<T, A>(factory: FactoryWithRequiredInput<T, A>, input: A[]): T[];
@@ -143,7 +170,14 @@ export declare function makeWithFactoryInput<T, A>(factory: FactoryWithRequiredI
  * Wraps a factory so that no arguments are forwarded when it's called.
  * Useful for protecting a factory from accidentally receiving arguments.
  *
+ * @dbxUtil
+ * @dbxUtilCategory getter
+ * @dbxUtilKind factory
+ * @dbxUtilTags getter, factory, protect, wrap, no-args
+ * @dbxUtilRelated as-getter, make-getter
+ *
  * @param factory - The factory to wrap
  * @returns A new factory that calls the original with no arguments
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function protectedFactory<T>(factory: Factory<T>): Factory<T>;

package/src/lib/getter/getter.map.d.ts

@@ -15,7 +15,14 @@ export declare function mapGetter<I, O>(input: Getter<I>, mapFn: MapFunction<I,
 /**
  * Creates a factory that wraps Getters with a mapping function.
  *
+ * @dbxUtil
+ * @dbxUtilCategory getter
+ * @dbxUtilKind factory
+ * @dbxUtilTags getter, map, transform, factory
+ * @dbxUtilRelated map-getter
+ *
  * @param mapFn - The mapping function to apply
  * @returns A factory that transforms Getters of type I to Getters of type O
+ * @__NO_SIDE_EFFECTS__
  */
 export declare function mapGetterFactory<I, O>(mapFn: MapFunction<I, O>): MapGetterFactory<I, O>;