@dereekb/util 13.11.14 → 13.11.15

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

@@ -26,22 +26,22 @@ export declare const FRACTIONAL_HOURS_PRECISION_FUNCTION: import("..").CutValueT
  *
  * Minutes are rounded down before conversion.
  *
- * @param minutes - Number of minutes to convert
- * @returns The equivalent fractional hour value
+ * @param minutes - Number of minutes to convert.
+ * @returns The equivalent fractional hour value.
  */
 export declare function minutesToFractionalHours(minutes: Minutes): FractionalHour;
 /**
  * Converts a fractional hour value to the equivalent number of minutes.
  *
- * @param hours - Fractional hour value to convert
+ * @param hours - Fractional hour value to convert.
  * @returns The equivalent number of minutes (rounded)
  */
 export declare function fractionalHoursToMinutes(hours: FractionalHour): Minutes;
 /**
  * Rounds the input hour to the nearest FractionalHour precision (3 decimal places).
  *
- * @param hour - The hour value to round
- * @returns The rounded fractional hour
+ * @param hour - The hour value to round.
+ * @returns The rounded fractional hour.
  */
 export declare function hourToFractionalHour(hour: Hours): FractionalHour;
 /**
@@ -54,9 +54,9 @@ export interface ComputeFractionalHour {
 /**
  * Computes the next fractional hour by adding the specified hours and minutes to the input value.
  *
- * @param input - The starting fractional hour value
- * @param change - The hours and/or minutes to add
- * @returns The resulting fractional hour
+ * @param input - The starting fractional hour value.
+ * @param change - The hours and/or minutes to add.
+ * @returns The resulting fractional hour.
  */
 export declare function computeNextFractionalHour(input: FractionalHour, change: ComputeFractionalHour): FractionalHour;
 /**
@@ -74,8 +74,8 @@ export declare const HOUR_OF_DAY_MAXMIMUM: number;
 /**
  * Returns true if the input value is a valid HourOfDay (0-23).
  *
- * @param input - The number to validate
- * @returns True if the input is within the valid HourOfDay range
+ * @param input - Candidate value to validate against the HourOfDay range.
+ * @returns True when the value falls within 0-23.
  */
 export declare function isHourOfDay(input: number): input is HourOfDay;
 /**
@@ -93,8 +93,8 @@ export declare const MINUTE_OF_DAY_MAXMIMUM: number;
 /**
  * Returns true if the input value is a valid MinuteOfDay (0-1439).
  *
- * @param input - The number to validate
- * @returns True if the input is within the valid MinuteOfDay range
+ * @param input - Candidate value to validate against the MinuteOfDay range.
+ * @returns True when the value falls within 0-1439.
  */
 export declare function isMinuteOfDay(input: number): input is MinuteOfDay;
 /**
@@ -107,15 +107,15 @@ export interface HoursAndMinutes {
 /**
  * Converts the input number of minutes to the equivalent in hours and minutes.
  *
- * @param inputMinutes - Total minutes to convert
- * @returns An object with the hour and minute components
+ * @param inputMinutes - Total minutes to break down.
+ * @returns Split hour-and-minute pair representing the same duration.
  */
 export declare function minutesToHoursAndMinutes(inputMinutes: Minutes): HoursAndMinutes;
 /**
  * Reads the hour and minutes of the Date in the local timezone.
  *
- * @param date - The date to extract hours and minutes from
- * @returns An object with the hour and minute components
+ * @param date - Reference instant whose local clock time should be split.
+ * @returns Local-time hour-and-minute pair for `date`.
  */
 export declare function dateToHoursAndMinutes(date: Date): HoursAndMinutes;
 /**
@@ -123,7 +123,7 @@ export declare function dateToHoursAndMinutes(date: Date): HoursAndMinutes;
  *
  * @param hour - The hour component (0-23)
  * @param minute - The minute component (0-59)
- * @returns The corresponding MinuteOfDay value
+ * @returns The corresponding MinuteOfDay value.
  */
 export declare function toMinuteOfDay(hour: Hours, minute: Minutes): MinuteOfDay;
 /**
@@ -131,20 +131,20 @@ export declare function toMinuteOfDay(hour: Hours, minute: Minutes): MinuteOfDay
  *
  * @param minuteOfDay - The minute of the day (0-1439)
  * @param day - Optional base date to use (defaults to the current date)
- * @returns A Date with the time set to the specified minute of day
+ * @returns Instant at the requested minute-of-day on the supplied calendar day.
  */
 export declare function dateFromMinuteOfDay(minuteOfDay: Minutes | MinuteOfDay, day?: Date): Date;
 /**
  * Converts a Date to a MinuteOfDay based on the local timezone.
  *
- * @param date - The date to convert
- * @returns The MinuteOfDay for the given date
+ * @param date - Reference instant whose local clock should be folded into the day.
+ * @returns Minute-of-day for `date` in the system timezone.
  */
 export declare function dateToMinuteOfDay(date: Date): MinuteOfDay;
 /**
  * Converts the input minutes to a valid MinuteOfDay by wrapping around the day boundary.
  *
- * @param minutes - The minutes value to convert
+ * @param minutes - The minutes value to convert.
  * @returns A MinuteOfDay value (0-1439)
  */
 export declare function asMinuteOfDay(minutes: Minutes): MinuteOfDay;
@@ -157,7 +157,7 @@ export declare function asMinuteOfDay(minutes: Minutes): MinuteOfDay;
  * - { hour: 1 } -> "1 hours"
  * - { minute: 30 } -> "30 minutes"
  *
- * @param input - The hours and minutes to format
- * @returns A human-readable string representation
+ * @param input - The hours and minutes to format.
+ * @returns A human-readable string representation.
  */
 export declare function hoursAndMinutesToString(input: HoursAndMinutes): string;

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

@@ -2,8 +2,8 @@ import { type Milliseconds, type Minutes, type Seconds } from './date';
 /**
  * Converts the input number of milliseconds to whole minutes by flooring the result.
  *
- * @param milliseconds - The number of milliseconds to convert.
- * @returns The equivalent whole minutes, rounded down.
+ * @param milliseconds - Duration to truncate down to whole minutes.
+ * @returns Floor of the equivalent minutes count.
  *
  * @example
  * ```ts
@@ -24,14 +24,14 @@ export interface MinutesAndSeconds {
  *
  * Rounds down to the nearest second.
  *
- * @param milliseconds - The number of milliseconds to convert
- * @returns An object with the minute and second components
+ * @param milliseconds - Duration to split into minute + second components.
+ * @returns Minute-second pair representing the same duration (seconds floored).
  */
 export declare function millisecondsToMinutesAndSeconds(milliseconds: Milliseconds): MinutesAndSeconds;
 /**
  * Converts the input number of seconds to the equivalent in minutes and seconds.
  *
- * @param inputSeconds - The number of seconds to convert
- * @returns An object with the minute and second components
+ * @param inputSeconds - Duration to split into minute + second components.
+ * @returns Minute-second pair representing the same duration.
  */
 export declare function secondsToMinutesAndSeconds(inputSeconds: Seconds): MinutesAndSeconds;

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

@@ -24,9 +24,9 @@ export type TimePeriodCounter = (() => number) & {
  * Returns the number of invocations since the current period started.
  * When a new period begins, the counter resets to 0.
  *
- * @param timePeriodLength - Length of each time period in milliseconds
- * @param lastTimePeriodStart - Optional starting point for the first period
- * @returns A callable counter function with metadata properties
+ * @param timePeriodLength - Length of each time period in milliseconds.
+ * @param lastTimePeriodStart - Optional starting point for the first period.
+ * @returns A callable counter function with metadata properties.
  */
 export declare function timePeriodCounter(timePeriodLength: number, lastTimePeriodStart?: Maybe<Date>): TimePeriodCounter;
 export type TimerState = 'running' | 'paused' | 'complete' | 'cancelled';
@@ -104,29 +104,30 @@ export declare class TimerCancelledError extends BaseError {
 /**
  * Creates a new Timer from the input duration.
  *
+ * @param duration - The duration of the timer.
+ * @param startImmediately - Whether the timer should start immediately. Defaults to true.
+ * @returns The new Timer.
+ *
  * @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;
 /**
  * Toggles the input Timer's running state between running and stopped.
  *
- * @param timer - The timer to toggle
+ * @param timer - The timer to toggle.
  * @param toggleRun - If provided, forces the timer to run (true) or stop (false). Otherwise toggles the current state.
  */
 export declare function toggleTimerRunning(timer: Timer, toggleRun?: boolean): void;
 /**
  * Returns the approximate end date of the given timer. If a timer is already complete, it returns the time for now.
  *
- * @param timer - the timer whose end date to approximate
- * @returns a Date representing the estimated end time, or null if no duration remains
+ * @param timer - Timer whose remaining duration anchors the projected end.
+ * @returns Projected end instant; null when no duration remains to project.
  */
 export declare function approximateTimerEndDate(timer: Timer): Maybe<Date>;

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

@@ -16,8 +16,8 @@ export type DayOfWeek = Sunday | Monday | Tuesday | Wednesday | Thusrsday | Frid
  *
  * Equivalent to date.getDay().
  *
- * @param date - The date to get the day of week for
- * @returns The DayOfWeek value (0=Sunday through 6=Saturday)
+ * @param date - Reference instant whose local weekday should be reported.
+ * @returns Weekday for `date` indexed 0=Sunday through 6=Saturday.
  */
 export declare function dayOfWeek(date: Date): DayOfWeek;
 /**
@@ -27,8 +27,8 @@ export type IsInAllowedDaysOfWeekSetDecisionFunction = IsInSetDecisionFunction<D
 /**
  * Creates a DecisionFunction that checks whether the input day or Date falls within the allowed days of the week.
  *
- * @param allowedDaysOfWeek - Set of allowed DayOfWeek values
- * @returns A decision function that checks membership in the allowed set
+ * @param allowedDaysOfWeek - Set of allowed DayOfWeek values.
+ * @returns Reusable predicate that yields true when a date or weekday falls in the allowed set.
  */
 export declare function isInAllowedDaysOfWeekSet(allowedDaysOfWeek: Set<DayOfWeek>): IsInAllowedDaysOfWeekSetDecisionFunction;
 /**
@@ -38,7 +38,7 @@ export declare function isInAllowedDaysOfWeekSet(allowedDaysOfWeek: Set<DayOfWee
  *
  * @param startingOn - The day to start from (defaults to Sunday)
  * @param maxDays - Maximum number of days to return (defaults to 7)
- * @returns An array of DayOfWeek values
+ * @returns Successive weekdays beginning at `startingOn`, capped at `maxDays`.
  */
 export declare function daysOfWeekArray(startingOn?: DayOfWeek, maxDays?: number): DayOfWeek[];
 /**
@@ -68,15 +68,15 @@ export interface EnabledDays {
 /**
  * Creates an EnabledDays object from an iterable of Day enum values.
  *
- * @param input - Iterable of Day values to mark as enabled
- * @returns An EnabledDays object with the specified days set to true
+ * @param input - Iterable of Day values to mark as enabled.
+ * @returns Per-weekday flag record with `true` for every day present in `input`.
  */
 export declare function enabledDaysFromDaysOfWeek(input: Maybe<Iterable<Day>>): EnabledDays;
 /**
  * Converts an EnabledDays object to an array of Day enum values.
  *
- * @param input - The EnabledDays object to convert
- * @returns An array of Day values for all enabled days
+ * @param input - Per-weekday flag record specifying which days are enabled.
+ * @returns Weekdays whose flag is true, ordered Sunday through Saturday.
  */
 export declare function daysOfWeekFromEnabledDays(input: Maybe<EnabledDays>): Day[];
 /**
@@ -88,27 +88,27 @@ export interface DayOfWeekNamesTransformConfig {
      *
      * I.E. Mon, Tue, etc.
      */
-    abbreviation?: boolean;
+    readonly abbreviation?: boolean;
     /**
      * Whether or not to uppercase the days.
      *
      * I.E. MONDAY, TUE, etc.
      */
-    uppercase?: boolean;
+    readonly uppercase?: boolean;
 }
 /**
  * Returns an array of strings with each day of the week named.
  *
- * @param sundayFirst - If true (default), Sunday is the first day; otherwise Monday is first
- * @param transform - Optional configuration for abbreviation and casing
- * @returns Array of day name strings
+ * @param sundayFirst - If true (default), Sunday is the first day; otherwise Monday is first.
+ * @param transform - Optional configuration for abbreviation and casing.
+ * @returns Localized weekday labels ordered per `sundayFirst` and styled per `transform`.
  */
 export declare function getDaysOfWeekNames(sundayFirst?: boolean, transform?: DayOfWeekNamesTransformConfig): string[];
 /**
  * Creates a Map from DayOfWeek values to their string names.
  *
- * @param transform - Optional configuration for abbreviation and casing
- * @returns A Map from DayOfWeek to name string
+ * @param transform - Optional configuration for abbreviation and casing.
+ * @returns Lookup pairing each weekday with its formatted name.
  */
 export declare function daysOfWeekNameMap(transform?: DayOfWeekNamesTransformConfig): Map<DayOfWeek, string>;
 /**
@@ -118,52 +118,53 @@ export type DayOfWeekNameFunction = (dayOfWeek: DayOfWeek) => string;
 /**
  * Creates a function that returns the name for a given DayOfWeek.
  *
+ * @param transform - Optional configuration for abbreviation and casing.
+ * @returns Reusable resolver that maps a weekday to its formatted name (or 'UNKNOWN').
+ *
  * @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;
 /**
  * Returns the DayOfWeek for the day after the given day.
  *
- * @param day - The starting day
- * @returns The next day of the week
+ * @param day - The starting day.
+ * @returns The next day of the week.
  */
 export declare function getDayTomorrow(day: DayOfWeek): DayOfWeek;
 /**
  * Returns the DayOfWeek for the day before the given day.
  *
- * @param day - The starting day
- * @returns The previous day of the week
+ * @param day - The starting day.
+ * @returns The previous day of the week.
  */
 export declare function getDayYesterday(day: DayOfWeek): DayOfWeek;
 /**
  * Returns the DayOfWeek offset by the given number of days (positive = forward, negative = backward).
  *
- * @param day - The starting day
- * @param days - The number of days to offset (positive or negative)
- * @returns The resulting DayOfWeek
+ * @param day - Starting weekday from which to offset.
+ * @param days - Signed step count (positive advances; negative rewinds).
+ * @returns Weekday after applying the signed offset, wrapping at week boundaries.
  */
 export declare function getDayOffset(day: DayOfWeek, days: number): DayOfWeek;
 /**
  * Returns the DayOfWeek that is the given number of days before the input day.
  *
- * @param day - The starting day
- * @param days - The number of days to go back (defaults to 1)
- * @returns The resulting DayOfWeek
+ * @param day - Starting weekday from which to rewind.
+ * @param days - Step count to walk backwards; defaults to 1.
+ * @returns Weekday `days` positions earlier, wrapping at week boundaries.
  */
 export declare function getPreviousDay(day: DayOfWeek, days?: number): DayOfWeek;
 /**
  * Returns the DayOfWeek that is the given number of days after the input day.
  *
- * @param day - The starting day
- * @param days - The number of days to advance (defaults to 1)
- * @returns The resulting DayOfWeek
+ * @param day - Starting weekday from which to advance.
+ * @param days - Step count to walk forwards; defaults to 1.
+ * @returns Weekday `days` positions later, wrapping at week boundaries.
  */
 export declare function getNextDay(day: DayOfWeek, days?: number): DayOfWeek;

package/src/lib/encryption/encryption.object.d.ts

@@ -95,6 +95,9 @@ export interface SelectiveFieldEncryptor<T, F extends keyof T> {
  * Each encrypted field's value is JSON.stringified before encryption and JSON.parsed after
  * decryption, so fields can hold any JSON-serializable value (not just strings).
  *
+ * @param config - Encryption configuration specifying provider, fields, and optional prefix.
+ * @returns A selective field encryptor instance.
+ *
  * @example
  * ```ts
  * const encryptor = selectiveFieldEncryptor({
@@ -108,8 +111,5 @@ export interface SelectiveFieldEncryptor<T, F extends keyof T> {
  * const decrypted = encryptor.decrypt(encrypted);
  * // decrypted => { client_id: 'abc', client_secret: 's3cret' }
  * ```
- *
- * @param config - Encryption configuration specifying provider, fields, and optional prefix.
- * @returns A selective field encryptor instance.
  */
 export declare function selectiveFieldEncryptor<T extends object, F extends keyof T>(config: SelectiveFieldEncryptionConfig<T, F>): SelectiveFieldEncryptor<T, F>;

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

@@ -34,8 +34,8 @@ export interface ReadableError extends Partial<CodedError> {
 /**
  * Checks if the error has the default error code or no code at all.
  *
- * @param error - A ReadableError or error code string to check
- * @returns True if the error uses the default code or has no code
+ * @param error - A ReadableError or error code string to check.
+ * @returns True if the error uses the default code or has no code.
  */
 export declare function isDefaultReadableError(error: Maybe<ReadableError | StringErrorCode>): boolean;
 /**
@@ -45,9 +45,9 @@ export type ReadableErrorWithCode<T extends ReadableError = ReadableError> = T &
 /**
  * Creates a ReadableError with a code and optional message.
  *
- * @param code - The error code
- * @param message - Optional human-readable error message
- * @returns A ReadableErrorWithCode object
+ * @param code - The error code.
+ * @param message - Optional human-readable error message.
+ * @returns A ReadableErrorWithCode object.
  */
 export declare function readableError(code: StringErrorCode, message?: string): ReadableErrorWithCode;
 /**
@@ -78,9 +78,9 @@ export declare function toReadableError(inputError: Maybe<ErrorInput>): Maybe<Co
 /**
  * Checks if an error's message contains the target string.
  *
- * @param input - The error or string to check
- * @param target - The string to search for in the error message
- * @returns True if the error message contains the target string
+ * @param input - Error-shaped value or message string to inspect; nullish short-circuits to false.
+ * @param target - Substring that must appear in the resolved error message.
+ * @returns True when the error message includes `target`.
  */
 export declare function errorMessageContainsString(input: Maybe<ErrorInput | string>, target: string): boolean;
 /**
@@ -90,21 +90,22 @@ export type ErrorMessageContainsStringFunction = (input: Maybe<ErrorInput | stri
 /**
  * Creates a function that checks if an error's message contains the target string.
  *
+ * @param target - Substring that must appear in the resolved error message.
+ * @returns Reusable predicate that yields true when the inspected error contains `target`.
+ *
  * @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;
 /**
  * Extracts the message string from an error or returns the input if it's already a string.
  *
- * @param input - The error or string to extract a message from
- * @returns The error message string, or null/undefined if not available
+ * @param input - The error or string to extract a message from.
+ * @returns The error message string, or null/undefined if not available.
  */
 export declare function messageFromError(input: Maybe<ErrorInput | string>): Maybe<string>;

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

@@ -13,8 +13,8 @@ export interface ServerError<T = ServerErrorResponseData> extends ReadableDataEr
 /**
  * Type guard that checks if the input is a ServerError (has both status and code properties).
  *
- * @param input - The value to check
- * @returns True if the input is a ServerError
+ * @param input - The value to check.
+ * @returns True if the input is a ServerError.
  */
 export declare function isServerError(input: unknown): input is ServerError;
 /**
@@ -40,8 +40,8 @@ export interface ServerErrorMakeConfig<T> extends ServerError<T>, Partial<CodedE
 /**
  * Creates a ServerError from the given configuration.
  *
- * @param config - The server error configuration
- * @returns A ServerError object
+ * @param config - The server error configuration.
+ * @returns A ServerError object.
  */
 export declare function serverError<T>(config: ServerErrorMakeConfig<T>): ServerError<T>;
 /**

package/src/lib/file/pdf.d.ts

@@ -31,7 +31,7 @@ export declare const PDF_ENCRYPT_MARKER = "/Encrypt";
  * the expected start/end markers are present.
  *
  * @param buffer - Buffer-like object to check. Only requires the `lastIndexOf` method.
- * @returns true if both PDF markers are found in the expected positions.
+ * @returns True if both PDF markers are found in the expected positions.
  */
 export declare function bufferHasValidPdfMarkings(buffer: Pick<Buffer<ArrayBuffer>, 'lastIndexOf' | 'includes'>): boolean;
 /**
@@ -48,6 +48,9 @@ export declare function bufferHasValidPdfMarkings(buffer: Pick<Buffer<ArrayBuffe
  * Note: this returns true for both fully-encrypted PDFs and write-protected-only PDFs.
  * Use `detectPdfEncryption` from `@dereekb/nestjs` when that distinction matters.
  *
+ * @param buffer - Buffer-like object to check. Only requires the `includes` method.
+ * @returns True if the buffer contains a `/Encrypt` entry indicating password protection.
+ *
  * @example
  * ```ts
  * const pdfBytes = await readFile('protected.pdf');
@@ -57,8 +60,5 @@ export declare function bufferHasValidPdfMarkings(buffer: Pick<Buffer<ArrayBuffe
  *   throw new Error('Password-protected PDFs are not supported.');
  * }
  * ```
- *
- * @param buffer - Buffer-like object to check. Only requires the `includes` method.
- * @returns true if the buffer contains a `/Encrypt` entry indicating password protection.
  */
 export declare function isPdfPasswordProtected(buffer: Pick<Buffer<ArrayBuffer>, 'includes'>): boolean;

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

@@ -18,14 +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.
  *
+ * @param inputFilters - The filter functions to merge.
+ * @returns A single FilterFunction that applies all filters.
+ *
  * @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,15 +5,16 @@ export type BooleanReturnFunction = (...args: any[]) => boolean;
 /**
  * Inverts the output of an arbitrary boolean-returning 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.
+ *
  * @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,14 +10,15 @@ export type ForwardFunction<I extends (...args: any[]) => O, O = unknown> = I;
  *
  * Useful for late-binding or circular dependency resolution.
  *
+ * @param getter - A Getter that provides the target function.
+ * @returns A forwarding function with the same signature as the target.
+ *
  * @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>;
@@ -29,14 +30,15 @@ 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.
  *
+ * @param defaultFn - The default function to use as fallback.
+ * @returns A factory that wraps optional functions with a default fallback.
+ *
  * @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>;