@dereekb/dbx-form 13.6.17 → 13.7.0

package/fesm2022/dereekb-dbx-form.mjs

@@ -730,7 +730,7 @@ class DbxFormSourceDirective {
             subscription = dbxFormSourceObservableFromStream(guardedStream$, formSource, mode).subscribe((x) => {
                 isSettingValue = true;
                 this.form.setValue(x);
-                Promise.resolve().then(() => (isSettingValue = false));
+                void Promise.resolve().then(() => (isSettingValue = false));
             });
         }
         this._effectSub.setSub(subscription);
@@ -1022,20 +1022,26 @@ const INVALID_PHONE_NUMBER_EXTENSION_MESSAGE = { name: 'validatePhoneNumberExten
  * Returns a validation message indicating the duration is below the minimum allowed.
  *
  * @param err - The validation error object containing `min` and `actual` values.
- * @param field - The Formly field configuration.
+ * @param err.min - The minimum allowed duration value.
+ * @param err.actual - The actual duration value that failed validation.
+ * @param err.unit - The duration unit label (e.g. "minutes", "hours").
+ * @param _field - The Formly field configuration.
  * @returns A human-readable validation message string.
  */
-function durationMinValidationMessage(err, field) {
+function durationMinValidationMessage(err, _field) {
     return `Duration must be at least ${err.min} ${err.unit} (currently ${err.actual} ${err.unit}).`;
 }
 /**
  * Returns a validation message indicating the duration exceeds the maximum allowed.
  *
  * @param err - The validation error object containing `max`, `actual`, and `unit` values.
- * @param field - The Formly field configuration.
+ * @param err.max - The maximum allowed duration value.
+ * @param err.actual - The actual duration value that failed validation.
+ * @param err.unit - The duration unit label (e.g. "minutes", "hours").
+ * @param _field - The Formly field configuration.
  * @returns A human-readable validation message string.
  */
-function durationMaxValidationMessage(err, field) {
+function durationMaxValidationMessage(err, _field) {
     return `Duration must be at most ${err.max} ${err.unit} (currently ${err.actual} ${err.unit}).`;
 }
 /**
@@ -6740,6 +6746,7 @@ class DbxDurationPickerPopoverComponent extends AbstractPopoverDirective {
      * When carryOver is enabled, normalizes the data by converting to total milliseconds
      * and decomposing back into the picker's units (e.g., 60s becomes 1m, 7d becomes 1w).
      *
+     * @param data - The duration data to potentially normalize.
      * @returns Normalized or original data
      */
     _normalizeIfCarryOver(data) {
@@ -6787,6 +6794,8 @@ class DbxDurationPickerPopoverComponent extends AbstractPopoverDirective {
     }
     /**
      * Returns the current step based on whether shift is held.
+     *
+     * @returns 2 if shift is held, 1 otherwise.
      */
     get _currentStep() {
         return this._shiftHeld ? 2 : 1;
@@ -6820,7 +6829,10 @@ class DbxDurationPickerPopoverComponent extends AbstractPopoverDirective {
     /**
      * Executes an increment or decrement action if allowed.
      *
-     * @returns True if the action was performed
+     * @param action - Whether to increment or decrement the value.
+     * @param unit - The time unit to modify (e.g., 'h', 'min', 's').
+     * @param step - The number of units to add or subtract per action.
+     * @returns True if the action was performed.
      */
     _doAction(action, unit, step) {
         if (action === 'increment' && this.canIncrement(unit)) {
@@ -6872,6 +6884,8 @@ class DbxTimeDurationFieldComponent extends FieldType$1 {
     /**
      * Units used for decomposing/displaying duration text.
      * Includes 'ms' if the smallest picker unit would leave a remainder.
+     *
+     * @returns The list of time units used for display, always including 'ms'.
      */
     get displayUnits() {
         const units = [...this.pickerUnits];
@@ -6910,6 +6924,8 @@ class DbxTimeDurationFieldComponent extends FieldType$1 {
     }
     /**
      * Called when Enter is pressed in the text input.
+     *
+     * @param event - The keyboard event from pressing Enter; prevented to avoid form submission.
      */
     onTextEnter(event) {
         event.preventDefault();
@@ -6974,6 +6990,8 @@ class DbxTimeDurationFieldComponent extends FieldType$1 {
     }
     /**
      * Converts duration data to the output value and sets it on the form control.
+     *
+     * @param data - The decomposed duration data to convert and emit.
      */
     _syncOutputFromDurationData(data) {
         const ms = durationDataToMilliseconds(data);
@@ -6994,6 +7012,9 @@ class DbxTimeDurationFieldComponent extends FieldType$1 {
     }
     /**
      * Converts an output value (number, HoursAndMinutes, or TimeDurationData) to milliseconds.
+     *
+     * @param value - The output value to convert, interpreted according to the current {@link valueMode}.
+     * @returns The equivalent duration in milliseconds.
      */
     _outputValueToMilliseconds(value) {
         if (this.valueMode === 'duration_data') {